summaryrefslogtreecommitdiff
path: root/node_modules/tinyglobby/dist/index.d.cts
diff options
context:
space:
mode:
authorShipwreckt <me@shipwreckt.co.uk>2025-10-31 20:02:14 +0000
committerShipwreckt <me@shipwreckt.co.uk>2025-10-31 20:02:14 +0000
commit7a52ddeba2a68388b544f529d2d92104420f77b0 (patch)
tree15ddd47457a2cb4a96060747437d36474e4f6b4e /node_modules/tinyglobby/dist/index.d.cts
parent53d6ae2b5568437afa5e4995580a3fb679b7b91b (diff)
Changed from static to 11ty!
Diffstat (limited to 'node_modules/tinyglobby/dist/index.d.cts')
-rw-r--r--node_modules/tinyglobby/dist/index.d.cts147
1 files changed, 147 insertions, 0 deletions
diff --git a/node_modules/tinyglobby/dist/index.d.cts b/node_modules/tinyglobby/dist/index.d.cts
new file mode 100644
index 0000000..9d67dae
--- /dev/null
+++ b/node_modules/tinyglobby/dist/index.d.cts
@@ -0,0 +1,147 @@
+import { FSLike } from "fdir";
+
+//#region src/utils.d.ts
+
+/**
+* Converts a path to a pattern depending on the platform.
+* Identical to {@link escapePath} on POSIX systems.
+* @see {@link https://superchupu.dev/tinyglobby/documentation#convertPathToPattern}
+*/
+declare const convertPathToPattern: (path: string) => string;
+/**
+* Escapes a path's special characters depending on the platform.
+* @see {@link https://superchupu.dev/tinyglobby/documentation#escapePath}
+*/
+declare const escapePath: (path: string) => string;
+/**
+* Checks if a pattern has dynamic parts.
+*
+* Has a few minor differences with [`fast-glob`](https://github.com/mrmlnc/fast-glob) for better accuracy:
+*
+* - Doesn't necessarily return `false` on patterns that include `\`.
+* - Returns `true` if the pattern includes parentheses, regardless of them representing one single pattern or not.
+* - Returns `true` for unfinished glob extensions i.e. `(h`, `+(h`.
+* - Returns `true` for unfinished brace expansions as long as they include `,` or `..`.
+*
+* @see {@link https://superchupu.dev/tinyglobby/documentation#isDynamicPattern}
+*/
+declare function isDynamicPattern(pattern: string, options?: {
+ caseSensitiveMatch: boolean;
+}): boolean;
+//#endregion
+//#region src/index.d.ts
+interface GlobOptions {
+ /**
+ * Whether to return absolute paths. Disable to have relative paths.
+ * @default false
+ */
+ absolute?: boolean;
+ /**
+ * Enables support for brace expansion syntax, like `{a,b}` or `{1..9}`.
+ * @default true
+ */
+ braceExpansion?: boolean;
+ /**
+ * Whether to match in case-sensitive mode.
+ * @default true
+ */
+ caseSensitiveMatch?: boolean;
+ /**
+ * The working directory in which to search. Results will be returned relative to this directory, unless
+ * {@link absolute} is set.
+ *
+ * It is important to avoid globbing outside this directory when possible, even with absolute paths enabled,
+ * as doing so can harm performance due to having to recalculate relative paths.
+ * @default process.cwd()
+ */
+ cwd?: string | URL;
+ /**
+ * Logs useful debug information. Meant for development purposes. Logs can change at any time.
+ * @default false
+ */
+ debug?: boolean;
+ /**
+ * Maximum directory depth to crawl.
+ * @default Infinity
+ */
+ deep?: number;
+ /**
+ * Whether to return entries that start with a dot, like `.gitignore` or `.prettierrc`.
+ * @default false
+ */
+ dot?: boolean;
+ /**
+ * Whether to automatically expand directory patterns.
+ *
+ * Important to disable if migrating from [`fast-glob`](https://github.com/mrmlnc/fast-glob).
+ * @default true
+ */
+ expandDirectories?: boolean;
+ /**
+ * Enables support for extglobs, like `+(pattern)`.
+ * @default true
+ */
+ extglob?: boolean;
+ /**
+ * Whether to traverse and include symbolic links. Can slightly affect performance.
+ * @default true
+ */
+ followSymbolicLinks?: boolean;
+ /**
+ * An object that overrides `node:fs` functions.
+ * @default import('node:fs')
+ */
+ fs?: FileSystemAdapter;
+ /**
+ * Enables support for matching nested directories with globstars (`**`).
+ * If `false`, `**` behaves exactly like `*`.
+ * @default true
+ */
+ globstar?: boolean;
+ /**
+ * Glob patterns to exclude from the results.
+ * @default []
+ */
+ ignore?: string | readonly string[];
+ /**
+ * Enable to only return directories.
+ * If `true`, disables {@link onlyFiles}.
+ * @default false
+ */
+ onlyDirectories?: boolean;
+ /**
+ * Enable to only return files.
+ * @default true
+ */
+ onlyFiles?: boolean;
+ /**
+ * @deprecated Provide patterns as the first argument instead.
+ */
+ patterns?: string | readonly string[];
+ /**
+ * An `AbortSignal` to abort crawling the file system.
+ * @default undefined
+ */
+ signal?: AbortSignal;
+}
+type FileSystemAdapter = Partial<FSLike>;
+/**
+* Asynchronously match files following a glob pattern.
+* @see {@link https://superchupu.dev/tinyglobby/documentation#glob}
+*/
+declare function glob(patterns: string | readonly string[], options?: Omit<GlobOptions, "patterns">): Promise<string[]>;
+/**
+* @deprecated Provide patterns as the first argument instead.
+*/
+declare function glob(options: GlobOptions): Promise<string[]>;
+/**
+* Synchronously match files following a glob pattern.
+* @see {@link https://superchupu.dev/tinyglobby/documentation#globSync}
+*/
+declare function globSync(patterns: string | readonly string[], options?: Omit<GlobOptions, "patterns">): string[];
+/**
+* @deprecated Provide patterns as the first argument instead.
+*/
+declare function globSync(options: GlobOptions): string[];
+//#endregion
+export { FileSystemAdapter, GlobOptions, convertPathToPattern, escapePath, glob, globSync, isDynamicPattern }; \ No newline at end of file