@augment-vir/node/dist/augments/path/ancestor.d.ts

A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.

import { type MaybePromise } from '@augment-vir/common';
/**
 * Find an ancestor file path that matches the given `callback`. If no matches are found all the way
 * up until the system root, this returns `undefined`.
 *
 * @category Path : Node
 * @category Package : @augment-vir/node
 * @returns `undefined` if no matches are found.
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export declare function findAncestor(currentPath: string, callback: (path: string) => Promise<boolean>): Promise<string | undefined>; /**
 * Find an ancestor file path that matches the given `callback`. If no matches are found all the
 * way up until the system root, this returns `undefined`.
 *
 * @category Path : Node
 * @category Package : @augment-vir/node
 * @returns `undefined` if no matches are found.
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export declare function findAncestor(currentPath: string, callback: (path: string) => boolean): string | undefined; /**
 * Find an ancestor file path that matches the given `callback`. If no matches are found all the
 * way up until the system root, this returns `undefined`.
 *
 * @category Path : Node
 * @category Package : @augment-vir/node
 * @returns `undefined` if no matches are found.
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export declare function findAncestor(currentPath: string, callback: (path: string) => MaybePromise<boolean>): MaybePromise<string | undefined>;
/**
 * Join a list of paths to the given `parentDirPath`. This is particularly useful for getting full
 * paths from the output of
 * [`readdir`](https://nodejs.org/api/fs.html#fspromisesreaddirpath-options).
 *
 * @category Path : Node
 * @category Package : @augment-vir/node
 * @example
 *
 * ```ts
 * import {readdir} from 'node:fs/promises';
 * import {join} from 'node:path';
 *
 * const parentDir = join('my', 'path');
 * const dirs = joinFilesToDir(parentDir, await readdir(parentDir));
 * ```
 *
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export declare function joinFilesToDir(parentDirPath: string, childNames: ReadonlyArray<string>): Array<string>;