@rush-fs/core 0.1.0-alpha.0

package/index.d.ts

@@ -0,0 +1,251 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+export declare class Dirent {
+  readonly name: string
+  readonly parentPath: string
+  isFile(): boolean
+  isDirectory(): boolean
+  isSymbolicLink(): boolean
+  isBlockDevice(): boolean
+  isCharacterDevice(): boolean
+  isFIFO(): boolean
+  isSocket(): boolean
+  get path(): string
+}
+
+export declare class Stats {
+  readonly dev: number
+  readonly mode: number
+  readonly nlink: number
+  readonly uid: number
+  readonly gid: number
+  readonly rdev: number
+  readonly blksize: number
+  readonly ino: number
+  readonly size: number
+  readonly blocks: number
+  readonly atimeMs: number
+  readonly mtimeMs: number
+  readonly ctimeMs: number
+  readonly birthtimeMs: number
+  isFile(): boolean
+  isDirectory(): boolean
+  isSymbolicLink(): boolean
+  isBlockDevice(): boolean
+  isCharacterDevice(): boolean
+  isFIFO(): boolean
+  isSocket(): boolean
+  /** Returns atime as a Date object (Node.js compatible) */
+  get atime(): Date
+  /** Returns mtime as a Date object (Node.js compatible) */
+  get mtime(): Date
+  /** Returns ctime as a Date object (Node.js compatible) */
+  get ctime(): Date
+  /** Returns birthtime as a Date object (Node.js compatible) */
+  get birthtime(): Date
+}
+
+export declare function access(path: string, mode?: number | undefined | null): Promise<unknown>
+
+export declare function accessSync(path: string, mode?: number | undefined | null): void
+
+export declare function appendFile(
+  path: string,
+  data: string | Buffer,
+  options?: WriteFileOptions | undefined | null,
+): Promise<unknown>
+
+export declare function appendFileSync(
+  path: string,
+  data: string | Buffer,
+  options?: WriteFileOptions | undefined | null,
+): void
+
+export declare function chmod(path: string, mode: number): Promise<unknown>
+
+export declare function chmodSync(path: string, mode: number): void
+
+export declare function chown(path: string, uid: number, gid: number): Promise<unknown>
+
+export declare function chownSync(path: string, uid: number, gid: number): void
+
+export declare function copyFile(src: string, dest: string, mode?: number | undefined | null): Promise<unknown>
+
+export declare function copyFileSync(src: string, dest: string, mode?: number | undefined | null): void
+
+export declare function cp(src: string, dest: string, options?: CpOptions | undefined | null): Promise<unknown>
+
+export interface CpOptions {
+  recursive?: boolean
+  force?: boolean
+  errorOnExist?: boolean
+  preserveTimestamps?: boolean
+  dereference?: boolean
+  verbatimSymlinks?: boolean
+  /**
+   * Rush-FS extension: number of parallel threads for recursive copy.
+   * 0 or 1 means sequential; > 1 enables rayon parallel traversal.
+   */
+  concurrency?: number
+}
+
+export declare function cpSync(src: string, dest: string, options?: CpOptions | undefined | null): void
+
+export declare function exists(path: string): Promise<unknown>
+
+export declare function existsSync(path: string): boolean
+
+export declare function glob(pattern: string, options?: GlobOptions | undefined | null): Promise<unknown>
+
+export interface GlobOptions {
+  cwd?: string
+  withFileTypes?: boolean
+  exclude?: Array<string>
+  concurrency?: number
+  gitIgnore?: boolean
+}
+
+export declare function globSync(
+  pattern: string,
+  options?: GlobOptions | undefined | null,
+): Array<string> | Array<Dirent>
+
+export declare function link(existingPath: string, newPath: string): Promise<unknown>
+
+export declare function linkSync(existingPath: string, newPath: string): void
+
+export declare function lstat(path: string): Promise<unknown>
+
+export declare function lstatSync(path: string): Stats
+
+export declare function mkdir(path: string, options?: MkdirOptions | undefined | null): Promise<unknown>
+
+export interface MkdirOptions {
+  recursive?: boolean
+  mode?: number
+}
+
+export declare function mkdirSync(path: string, options?: MkdirOptions | undefined | null): string | null
+
+export declare function mkdtemp(prefix: string): Promise<unknown>
+
+export declare function mkdtempSync(prefix: string): string
+
+export declare function readdir(path: string, options?: ReaddirOptions | undefined | null): Promise<unknown>
+
+/** * Reads the contents of a directory.
+ * @param {string | Buffer | URL} path
+ * @param {string | {
+ *   encoding?: string;
+ *   withFileTypes?: boolean;
+ *   recursive?: boolean;
+ *   }} [options]
+ * @param {(
+ *   err?: Error,
+ *   files?: string[] | Buffer[] | Dirent[]
+ * ) => any} callback
+ * @returns {void}
+ */
+export interface ReaddirOptions {
+  /**
+   * File name encoding. 'utf8' (default) returns strings.
+   * 'buffer' returns Buffer objects for each name.
+   * Other values are treated as 'utf8'.
+   */
+  encoding?: string
+  skipHidden?: boolean
+  concurrency?: number
+  recursive?: boolean
+  withFileTypes?: boolean
+}
+
+export declare function readdirSync(
+  path: string,
+  options?: ReaddirOptions | undefined | null,
+): Array<string> | Array<Dirent>
+
+export declare function readFile(path: string, options?: ReadFileOptions | undefined | null): Promise<unknown>
+
+export interface ReadFileOptions {
+  encoding?: string
+  flag?: string
+}
+
+export declare function readFileSync(path: string, options?: ReadFileOptions | undefined | null): string | Buffer
+
+export declare function readlink(path: string): Promise<unknown>
+
+export declare function readlinkSync(path: string): string
+
+export declare function realpath(path: string): Promise<unknown>
+
+export declare function realpathSync(path: string): string
+
+export declare function rename(oldPath: string, newPath: string): Promise<unknown>
+
+export declare function renameSync(oldPath: string, newPath: string): void
+
+export declare function rm(path: string, options?: RmOptions | undefined | null): Promise<unknown>
+
+export declare function rmdir(path: string): Promise<unknown>
+
+export declare function rmdirSync(path: string): void
+
+/**
+ * Removes files and directories (modeled on the standard POSIX `rm` utility).
+ *
+ * - `force`: When true, silently ignore errors when path does not exist.
+ * - `recursive`: When true, remove directory and all its contents.
+ * - `maxRetries`: If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or `EPERM` error is
+ *   encountered, Node.js retries the operation with a linear backoff of `retryDelay` ms longer on
+ *   each try. This option represents the number of retries.
+ * - `retryDelay`: The amount of time in milliseconds to wait between retries (default 100ms).
+ * - `concurrency` (rush-fs extension): Number of parallel threads for recursive removal.
+ */
+export interface RmOptions {
+  force?: boolean
+  maxRetries?: number
+  recursive?: boolean
+  retryDelay?: number
+  concurrency?: number
+}
+
+export declare function rmSync(path: string, options?: RmOptions | undefined | null): void
+
+export declare function stat(path: string): Promise<unknown>
+
+export declare function statSync(path: string): Stats
+
+export declare function symlink(target: string, path: string, symlinkType?: string | undefined | null): Promise<unknown>
+
+export declare function symlinkSync(target: string, path: string, symlinkType?: string | undefined | null): void
+
+export declare function truncate(path: string, len?: number | undefined | null): Promise<unknown>
+
+export declare function truncateSync(path: string, len?: number | undefined | null): void
+
+export declare function unlink(path: string): Promise<unknown>
+
+export declare function unlinkSync(path: string): void
+
+export declare function utimes(path: string, atime: number, mtime: number): Promise<unknown>
+
+export declare function utimesSync(path: string, atime: number, mtime: number): void
+
+export declare function writeFile(
+  path: string,
+  data: string | Buffer,
+  options?: WriteFileOptions | undefined | null,
+): Promise<unknown>
+
+export interface WriteFileOptions {
+  encoding?: string
+  mode?: number
+  flag?: string
+}
+
+export declare function writeFileSync(
+  path: string,
+  data: string | Buffer,
+  options?: WriteFileOptions | undefined | null,
+): void