bellpull/which
Every export of bellpull/which, with its signature and doc comment: pathExtensions, extensionCandidates, searchPath, whichAllSync, whichSync, resolveExecutable and 5 more, plus 3 types.
import { pathExtensions, extensionCandidates, searchPath, … } from 'bellpull/which';Functions
extensionCandidates
The extensions tried for this command, in order.
function extensionCandidates(command: string, options: WhichOptions): string[];| Parameter | Type |
|---|---|
command | string |
options | WhichOptions |
Returns string[]
pathExtensions
The PATHEXT list for this runtime, as an array. [''] off Windows: no expansion.
function pathExtensions(options: WhichOptions): string[];| Parameter | Type |
|---|---|
options | WhichOptions |
Returns string[]
resolveExecutable
Where command resolves to for the purpose of spawning it — two PATHEXT attempts,
not one, as cross-spawn does.
function resolveExecutable(command: string, options: WhichOptions): Resolution | undefined;| Parameter | Type |
|---|---|
command | string |
options | WhichOptions |
Returns Resolution \| undefined
runPath
PATH with every node_modules/.bin from cwd upward in front of it — npm-run-path's
contract (104 M/wk, 2 dependencies, last published 2024-08-26).
function runPath(options: WhichOptions): string;| Parameter | Type |
|---|---|
options | WhichOptions |
Returns string
searchPath
The directories this runtime would search, in order — the static projection of resolution (PRINCIPLES rule 6).
function searchPath(options: WhichOptions): SearchEntry[];| Parameter | Type |
|---|---|
options | WhichOptions |
Returns SearchEntry[]
whichAllSync
Every place command resolves to, best first. Empty when it resolves nowhere.
function whichAllSync(command: string, options: WhichOptions): Resolution[];| Parameter | Type |
|---|---|
command | string |
options | WhichOptions |
Returns Resolution[]
whichOrThrowSync
Where command resolves to, throwing {@link NotFoundError} when it resolves nowhere.
function whichOrThrowSync(command: string, options: WhichOptions): Resolution;| Parameter | Type |
|---|---|
command | string |
options | WhichOptions |
Returns Resolution
whichSync
Where command resolves to, or undefined.
function whichSync(command: string, options: WhichOptions): Resolution | undefined;| Parameter | Type |
|---|---|
command | string |
options | WhichOptions |
Returns Resolution \| undefined
Classes
NotFoundError
Error with the code a caller switches on, and the command it could not find.
class NotFoundError extends Error {
readonly command: string;
readonly code = "ENOENT";
constructor(command: string);
}Constants
delimiter
The platform-specific file delimiter. ';' or ':'.
const delimiter: ";" | ":";sep
The platform-specific file separator. '\' or '/'.
const sep: "\\" | "/";Interfaces
Resolution
Where an executable was found, and what found it.
interface Resolution {
/** The absolute path of the file that would be executed. */
path: string;
/**
* The `PATH` entry it was found under, or `''` when the command carried its own path and
* `PATH` was never consulted. This is the field no incumbent returns.
*/
from: string;
/**
* The extension appended from `PATHEXT` to find it — `.CMD`, `.EXE`. Always `''` off
* Windows, where the file is executable or it is not.
*/
ext: string;
}SearchEntry
One directory to search, and whether it was skipped and why.
interface SearchEntry {
/** The entry as it appeared on `PATH`, before quotes were stripped or it was resolved. */
raw: string;
/** The absolute directory that will be searched, when it will be. */
dir?: string;
/** Why it will not be, when it will not: a reader can see the hole rather than infer it. */
skipped?: 'empty' | 'relative';
}WhichOptions
interface WhichOptions {
/** The ambient state. Required in spirit; defaulted only by the façades. */
runtime: Runtime;
/** Override the `PATH` string. Overrides `runtime.env`'s, as `which`'s `path` does. */
path?: string | undefined;
/** Override `PATHEXT`. `''` disables extension expansion entirely. */
pathExt?: string | undefined;
/** Resolve relative entries and relative commands against this instead of `runtime.cwd`. */
cwd?: string | undefined;
}bellpull
Every export of bellpull, with its signature and doc comment: ambientRuntime, DEFAULT_GRACE, DEFAULT_TIMEOUT, escapeArgument, escapeCommand, extensionCandidates and 20 more, plus 9 types.
bellpull/node-which
Every export of bellpull/node-which, with its signature and doc comment: which, plus 1 type.