@hypernym/utils 3.4.4 → 3.4.6

package/dist/fs/{index.d.mts → index.d.ts}

@@ -1,5 +1,7 @@
-import { Dirent } from 'node:fs';
-import { writeFile as writeFile$1 } from 'node:fs/promises';
+import { Dirent } from "node:fs";
+import { writeFile as writeFile$1 } from "node:fs/promises";
+
+//#region src/fs/exists.d.ts
 
 /**
  * Checks if the `file` or `directory` exists.
@@ -9,33 +11,34 @@ import { writeFile as writeFile$1 } from 'node:fs/promises';
  * ```ts
  * import { exists } from '@hypernym/utils/fs'
  *
- * await exists('dir/file.ts') // => true
+ * await exists('dir/file.ts') // true
  * ```
  */
 declare function exists(path: string): Promise<boolean>;
-
+//#endregion
+//#region src/fs/read.d.ts
 type ReadPath = string | URL;
 type ReadEncodingType = BufferEncoding | null | undefined;
 type ReadType<T> = T extends BufferEncoding | undefined ? string : T extends null ? Buffer : never;
 interface ReadOptions<T extends ReadEncodingType> {
-    /**
-     * If no encoding is specified, the data is returned as a `Buffer` object. Otherwise, the data will be a string.
-     *
-     * @default 'utf-8'
-     */
-    encoding?: T;
-    /**
-     * When provided the corresponding `AbortController` can be used to cancel an asynchronous action.
-     *
-     * @default undefined
-     */
-    signal?: AbortSignal;
-    /**
-     * If a flag is not provided, it defaults to `'r'`.
-     *
-     * @default 'r'
-     */
-    flag?: number | string;
+  /**
+   * If no encoding is specified, the data is returned as a `Buffer` object. Otherwise, the data will be a string.
+   *
+   * @default 'utf-8'
+   */
+  encoding?: T;
+  /**
+   * When provided the corresponding `AbortController` can be used to cancel an asynchronous action.
+   *
+   * @default undefined
+   */
+  signal?: AbortSignal;
+  /**
+   * If a flag is not provided, it defaults to `'r'`.
+   *
+   * @default 'r'
+   */
+  flag?: number | string;
 }
 /**
  * Reads the entire contents of a `file`.
@@ -49,30 +52,31 @@ interface ReadOptions<T extends ReadEncodingType> {
  * ```
  */
 declare function read<T extends ReadEncodingType = BufferEncoding>(path: ReadPath, options?: ReadOptions<T>): Promise<ReadType<T>>;
-
+//#endregion
+//#region src/fs/readdir.d.ts
 type ReaddirPath = string | URL;
 type ReaddirEncodingType = BufferEncoding | null | 'buffer' | undefined;
 type ReaddirWithFileType = true | undefined;
 type ReaddirType<E, F> = F extends true ? Dirent : E extends BufferEncoding | undefined ? string : E extends null | 'buffer' ? Buffer : never;
 interface ReaddirOptions<E extends ReaddirEncodingType, F extends ReaddirWithFileType> {
-    /**
-     * If the encoding is set to `'buffer'` or `null`, the filenames returned will be passed as `Buffer` objects.
-     *
-     * @default 'utf-8'
-     */
-    encoding?: E;
-    /**
-     * If `withFileTypes` is set to `true`, the returned array will contain `fs.Dirent` objects.
-     *
-     * @default undefined
-     */
-    withFileTypes?: F;
-    /**
-     * Reads the directory recursively.
-     *
-     * @default true
-     */
-    recursive?: boolean;
+  /**
+   * If the encoding is set to `'buffer'` or `null`, the filenames returned will be passed as `Buffer` objects.
+   *
+   * @default 'utf-8'
+   */
+  encoding?: E;
+  /**
+   * If `withFileTypes` is set to `true`, the returned array will contain `fs.Dirent` objects.
+   *
+   * @default undefined
+   */
+  withFileTypes?: F;
+  /**
+   * Reads the directory recursively.
+   *
+   * @default true
+   */
+  recursive?: boolean;
 }
 /**
  * Reads the contents of a `directory` recursively.
@@ -86,7 +90,8 @@ interface ReaddirOptions<E extends ReaddirEncodingType, F extends ReaddirWithFil
  * ```
  */
 declare function readdir<E extends ReaddirEncodingType = BufferEncoding, F extends ReaddirWithFileType = undefined>(path: ReaddirPath, options?: ReaddirOptions<E, F>): Promise<ReaddirType<E, F>[]>;
-
+//#endregion
+//#region src/fs/write.d.ts
 type WritePath = string | URL;
 /**
  * Writes data to a `file` recursively.
@@ -104,24 +109,25 @@ declare function write(path: WritePath, data: Parameters<typeof writeFile$1>[1],
  * @deprecated Use `write` instead.
  */
 declare const writeFile: typeof write;
-
+//#endregion
+//#region src/fs/copy.d.ts
 type CopySource = string | URL;
 type CopyDestination = string | URL;
 interface CopyOptions {
-    /**
-     * Copies files or directories recursively.
-     *
-     * @default true
-     */
-    recursive?: boolean;
-    /**
-     * Filters copied `files` or `directories`.
-     *
-     * Returns `true` to copy the item, `false` to ignore it.
-     *
-     * @default undefined
-     */
-    filter?(source: string, destination: string): boolean | Promise<boolean>;
+  /**
+   * Copies files or directories recursively.
+   *
+   * @default true
+   */
+  recursive?: boolean;
+  /**
+   * Filters copied `files` or `directories`.
+   *
+   * Returns `true` to copy the item, `false` to ignore it.
+   *
+   * @default undefined
+   */
+  filter?(source: string, destination: string): boolean | Promise<boolean>;
 }
 /**
  * Copies `files` or `directories` recursively.
@@ -137,23 +143,24 @@ interface CopyOptions {
  * ```
  */
 declare function copy(source: CopySource | CopySource[], destination: CopyDestination, options?: CopyOptions): Promise<void>;
-
+//#endregion
+//#region src/fs/mkdir.d.ts
 type MakeDirPath = string | URL;
 interface MakeDirOptions {
-    /**
-     * Indicates whether parent folders should be created.
-     *
-     * If a folder was created, the path to the first created folder will be returned.
-     *
-     * @default true
-     */
-    recursive?: boolean;
-    /**
-     * A file mode. If a string is passed, it is parsed as an octal integer.
-     *
-     * @default 0o777
-     */
-    mode?: string | number;
+  /**
+   * Indicates whether parent folders should be created.
+   *
+   * If a folder was created, the path to the first created folder will be returned.
+   *
+   * @default true
+   */
+  recursive?: boolean;
+  /**
+   * A file mode. If a string is passed, it is parsed as an octal integer.
+   *
+   * @default 0o777
+   */
+  mode?: string | number;
 }
 /**
  * Creates a `directory` recursively.
@@ -169,41 +176,42 @@ interface MakeDirOptions {
  * ```
  */
 declare function mkdir(path: MakeDirPath | MakeDirPath[], options?: MakeDirOptions): Promise<void>;
-
+//#endregion
+//#region src/fs/remove.d.ts
 type RemovePath = string | URL;
 interface RemoveOptions {
-    /**
-     * If `true`, perform a recursive directory removal.
-     *
-     * In recursive mode, operations are retried on failure.
-     *
-     * @default true
-     */
-    recursive?: boolean;
-    /**
-     * When `true`, exceptions will be ignored if `path` does not exist.
-     *
-     * @default true
-     */
-    force?: boolean;
-    /**
-     * 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`.
-     *
-     * @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`.
-     *
-     * @default 100
-     */
-    retryDelay?: number;
+  /**
+   * If `true`, perform a recursive directory removal.
+   *
+   * In recursive mode, operations are retried on failure.
+   *
+   * @default true
+   */
+  recursive?: boolean;
+  /**
+   * When `true`, exceptions will be ignored if `path` does not exist.
+   *
+   * @default true
+   */
+  force?: boolean;
+  /**
+   * 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`.
+   *
+   * @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`.
+   *
+   * @default 100
+   */
+  retryDelay?: number;
 }
 /**
  * Removes `files` and `directories` recursively.
@@ -219,6 +227,5 @@ interface RemoveOptions {
  * ```
  */
 declare function remove(path: RemovePath | RemovePath[], options?: RemoveOptions): Promise<void>;
-
-export { copy, exists, mkdir, read, readdir, remove, write, writeFile };
-export type { CopyDestination, CopyOptions, CopySource, MakeDirOptions, MakeDirPath, ReadEncodingType, ReadOptions, ReadPath, ReadType, ReaddirEncodingType, ReaddirOptions, ReaddirPath, ReaddirType, ReaddirWithFileType, RemoveOptions, RemovePath, WritePath };
+//#endregion
+export { CopyDestination, CopyOptions, CopySource, MakeDirOptions, MakeDirPath, ReadEncodingType, ReadOptions, ReadPath, ReadType, ReaddirEncodingType, ReaddirOptions, ReaddirPath, ReaddirType, ReaddirWithFileType, RemoveOptions, RemovePath, WritePath, copy, exists, mkdir, read, readdir, remove, write, writeFile };

package/dist/fs/index.js

@@ -0,0 +1,161 @@
+import { access, constants, cp, mkdir as mkdir$1, readFile, readdir as readdir$1, rm, writeFile as writeFile$1 } from "node:fs/promises";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+import { isString, isURL } from "../index.js";
+
+//#region src/fs/exists.ts
+/**
+* Checks if the `file` or `directory` exists.
+*
+* @example
+*
+* ```ts
+* import { exists } from '../index.js'
+*
+* await exists('dir/file.ts') // true
+* ```
+*/
+async function exists(path) {
+	return await access(path, constants.F_OK).then(() => true).catch(() => false);
+}
+
+//#endregion
+//#region src/fs/read.ts
+/**
+* Reads the entire contents of a `file`.
+*
+* @example
+*
+* ```ts
+* import { read } from '../index.js'
+*
+* await read('dir/subdir/file.ts')
+* ```
+*/
+async function read(path, options = {}) {
+	const { encoding = "utf-8" } = options;
+	return await readFile(path, {
+		encoding,
+		...options
+	});
+}
+
+//#endregion
+//#region src/fs/readdir.ts
+/**
+* Reads the contents of a `directory` recursively.
+*
+* @example
+*
+* ```ts
+* import { readdir } from '../index.js'
+*
+* await readdir('dir/subdir')
+* ```
+*/
+async function readdir(path, options = {}) {
+	const { encoding = "utf-8", recursive = true } = options;
+	return await readdir$1(path, {
+		encoding,
+		recursive,
+		...options
+	});
+}
+
+//#endregion
+//#region src/fs/write.ts
+/**
+* Writes data to a `file` recursively.
+*
+* @example
+*
+* ```ts
+* import { write } from '../index.js'
+*
+* await write('dir/subdir/file.ts', `console.log('Hello World!')`)
+* ```
+*/
+async function write(path, data, options) {
+	await mkdir$1(dirname(isURL(path) ? fileURLToPath(path) : path), { recursive: true });
+	await writeFile$1(path, data, options);
+}
+/**
+* @deprecated Use `write` instead.
+*/
+const writeFile = write;
+
+//#endregion
+//#region src/fs/copy.ts
+/**
+* Copies `files` or `directories` recursively.
+*
+* Accepts a single source or a range of sources.
+*
+* @example
+*
+* ```ts
+* import { copy } from '../index.js'
+*
+* await copy('src/subdir/file.ts', './dist/subdir')
+* ```
+*/
+async function copy(source, destination, options = {}) {
+	const { recursive = true, filter } = options;
+	const sources = isString(source) || isURL(source) ? [source] : source;
+	for (const src of sources) await cp(src, destination, {
+		recursive,
+		filter
+	});
+}
+
+//#endregion
+//#region src/fs/mkdir.ts
+/**
+* Creates a `directory` recursively.
+*
+* Accepts a single path or a range of paths.
+*
+* @example
+*
+* ```ts
+* import { mkdir } from '../index.js'
+*
+* await mkdir('src/subdir')
+* ```
+*/
+async function mkdir(path, options = {}) {
+	const { recursive = true, mode } = options;
+	const paths = isString(path) || isURL(path) ? [path] : path;
+	for (const p of paths) await mkdir$1(p, {
+		recursive,
+		mode
+	});
+}
+
+//#endregion
+//#region src/fs/remove.ts
+/**
+* Removes `files` and `directories` recursively.
+*
+* Accepts a single path or a range of paths.
+*
+* @example
+*
+* ```ts
+* import { remove } from '../index.js'
+*
+* await remove('src/subdir/file.ts')
+* ```
+*/
+async function remove(path, options = {}) {
+	const { recursive = true, force = true } = options;
+	const paths = isString(path) || isURL(path) ? [path] : path;
+	for (const p of paths) await rm(p, {
+		recursive,
+		force,
+		...options
+	});
+}
+
+//#endregion
+export { copy, exists, mkdir, read, readdir, remove, write, writeFile };