aboutsummaryrefslogtreecommitdiff
path: root/node_modules/locate-path/index.d.ts
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
committerJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
commit5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch)
tree360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/locate-path/index.d.ts
parentb500a50f1b97d93c98b36ed9a980f8188d648147 (diff)
downloadLYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz
LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/locate-path/index.d.ts')
-rw-r--r--node_modules/locate-path/index.d.ts83
1 files changed, 83 insertions, 0 deletions
diff --git a/node_modules/locate-path/index.d.ts b/node_modules/locate-path/index.d.ts
new file mode 100644
index 0000000..fbde526
--- /dev/null
+++ b/node_modules/locate-path/index.d.ts
@@ -0,0 +1,83 @@
+declare namespace locatePath {
+ interface Options {
+ /**
+ Current working directory.
+
+ @default process.cwd()
+ */
+ readonly cwd?: string;
+
+ /**
+ Type of path to match.
+
+ @default 'file'
+ */
+ readonly type?: 'file' | 'directory';
+
+ /**
+ Allow symbolic links to match if they point to the requested path type.
+
+ @default true
+ */
+ readonly allowSymlinks?: boolean;
+ }
+
+ interface AsyncOptions extends Options {
+ /**
+ Number of concurrently pending promises. Minimum: `1`.
+
+ @default Infinity
+ */
+ readonly concurrency?: number;
+
+ /**
+ Preserve `paths` order when searching.
+
+ Disable this to improve performance if you don't care about the order.
+
+ @default true
+ */
+ readonly preserveOrder?: boolean;
+ }
+}
+
+declare const locatePath: {
+ /**
+ Get the first path that exists on disk of multiple paths.
+
+ @param paths - Paths to check.
+ @returns The first path that exists or `undefined` if none exists.
+
+ @example
+ ```
+ import locatePath = require('locate-path');
+
+ const files = [
+ 'unicorn.png',
+ 'rainbow.png', // Only this one actually exists on disk
+ 'pony.png'
+ ];
+
+ (async () => {
+ console(await locatePath(files));
+ //=> 'rainbow'
+ })();
+ ```
+ */
+ (paths: Iterable<string>, options?: locatePath.AsyncOptions): Promise<
+ string | undefined
+ >;
+
+ /**
+ Synchronously get the first path that exists on disk of multiple paths.
+
+ @param paths - Paths to check.
+ @returns The first path that exists or `undefined` if none exists.
+ */
+ sync(
+ paths: Iterable<string>,
+ options?: locatePath.Options
+ ): string | undefined;
+};
+
+export = locatePath;