Changeset 79a0317 for imaps-frontend/node_modules/readdirp/index.d.ts

Timestamp:

01/21/25 03:08:24 (3 days ago)

Author:

stefan toskovski <stefantoska84@…>

Branches:

main

Parents:

0c6b92a

Message:

F4 Finalna Verzija

File:

• imaps-frontend/node_modules/readdirp/index.d.ts (modified) (4 diffs)

imaps-frontend/node_modules/readdirp/index.d.ts

@@ -1 @@
-import type { Stats, Dirent } from 'fs';
-import { Readable } from 'stream';
+/**
+ * Recursive version of readdir. Exposes a streaming API and promise API.
+ * Streaming API allows to use a small amount of RAM.
+ *
+ * @module
+ * @example
+```js
+import readdirp from 'readdirp';
+for await (const entry of readdirp('.')) {
+  const {path} = entry;
+  console.log(`${JSON.stringify({path})}`);
+}
+```
+ */
+/*! readdirp - MIT License (c) 2012-2019 Thorsten Lorenz, Paul Miller (https://paulmillr.com) */
+import type { Stats, Dirent } from 'node:fs';
+import { Readable } from 'node:stream';
+/** Path in file system. */
 export type Path = string;
+/** Emitted entry. Contains relative & absolute path, basename, and either stats or dirent. */
 export interface EntryInfo {
     path: string;
@@ -9 +26 @@
     basename: string;
 }
+/** Path or dir entries (files) */
 export type PathOrDirent = Dirent | Path;
-export type Tester = (path: EntryInfo) => boolean;
+/** Filterer for files */
+export type Tester = (entryInfo: EntryInfo) => boolean;
 export type Predicate = string[] | string | Tester;
-declare function defaultOptions(): {
+export declare const EntryTypes: {
+    readonly FILE_TYPE: "files";
+    readonly DIR_TYPE: "directories";
+    readonly FILE_DIR_TYPE: "files_directories";
+    readonly EVERYTHING_TYPE: "all";
+};
+export type EntryType = (typeof EntryTypes)[keyof typeof EntryTypes];
+/**
+ * Options for readdirp.
+ * * type: files, directories, or both
+ * * lstat: whether to use symlink-friendly stat
+ * * depth: max depth
+ * * alwaysStat: whether to use stat (more resources) or dirent
+ * * highWaterMark: streaming param, specifies max amount of resources per entry
+ */
+export type ReaddirpOptions = {
     root: string;
-    fileFilter: (_path: EntryInfo) => boolean;
-    directoryFilter: (_path: EntryInfo) => boolean;
-    type: string;
-    lstat: boolean;
-    depth: number;
-    alwaysStat: boolean;
-    highWaterMark: number;
+    fileFilter?: Predicate;
+    directoryFilter?: Predicate;
+    type?: EntryType;
+    lstat?: boolean;
+    depth?: number;
+    alwaysStat?: boolean;
+    highWaterMark?: number;
 };
-export type ReaddirpOptions = ReturnType<typeof defaultOptions>;
+/** Directory entry. Contains path, depth count, and files. */
 export interface DirEntry {
     files: PathOrDirent[];
@@ -28 +62 @@
     path: Path;
 }
+/** Readable readdir stream, emitting new files as they're being listed. */
 export declare class ReaddirpStream extends Readable {
     parents: any[];
@@ -55 +90 @@
     _formatEntry(dirent: PathOrDirent, path: Path): Promise<EntryInfo | undefined>;
     _onError(err: Error): void;
-    _getEntryType(entry: EntryInfo): Promise<void | "" | "file" | "directory">;
+    _getEntryType(entry: EntryInfo): Promise<void | '' | 'file' | 'directory'>;
     _includeAsFile(entry: EntryInfo): boolean | undefined;
 }
 /**
- * Main function which ends up calling readdirRec and reads all files and directories in given root recursively.
+ * Streaming version: Reads all files and directories in given root recursively.
+ * Consumes ~constant small amount of RAM.
  * @param root Root directory
  * @param options Options to specify root (start directory), filters and recursion depth
  */
-export declare const readdirp: (root: Path, options?: Partial<ReaddirpOptions>) => ReaddirpStream;
-export declare const readdirpPromise: (root: Path, options?: Partial<ReaddirpOptions>) => Promise<string[]>;
+export declare function readdirp(root: Path, options?: Partial<ReaddirpOptions>): ReaddirpStream;
+/**
+ * Promise version: Reads all files and directories in given root recursively.
+ * Compared to streaming version, will consume a lot of RAM e.g. when 1 million files are listed.
+ * @returns array of paths and their entry infos
+ */
+export declare function readdirpPromise(root: Path, options?: Partial<ReaddirpOptions>): Promise<EntryInfo[]>;
 export default readdirp;