@types/which/index.d.ts

// Type definitions for which 2.0
// Project: https://github.com/isaacs/node-which
// Definitions by: vvakame <https://github.com/vvakame>
//                 cspotcode <https://github.com/cspotcode>
//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/** Finds all instances of a specified executable in the PATH environment variable */
declare function which(
    cmd: string,
    options: which.AsyncOptions & which.OptionsAll,
    cb: (err: Error | null, paths: ReadonlyArray<string> | undefined) => void,
): void;
declare function which(
    cmd: string,
    options: which.AsyncOptions & which.OptionsFirst,
    cb: (err: Error | null, path: string | undefined) => void,
): void;
declare function which(
    cmd: string,
    options: which.AsyncOptions,
    cb: (err: Error | null, path: string | ReadonlyArray<string> | undefined) => void,
): void;
declare function which(cmd: string, cb: (err: Error | null, path: string | undefined) => void): void;
declare function which(cmd: string, options: which.AsyncOptions & which.OptionsAll): Promise<string[]>;
declare function which(cmd: string, options?: which.AsyncOptions & which.OptionsFirst): Promise<string>;

declare namespace which {
    /** Finds all instances of a specified executable in the PATH environment variable */
    function sync(cmd: string, options: Options & OptionsAll & OptionsNoThrow): ReadonlyArray<string> | null;
    function sync(cmd: string, options: Options & OptionsFirst & OptionsNoThrow): string | null;
    function sync(cmd: string, options: Options & OptionsAll & OptionsThrow): ReadonlyArray<string>;
    function sync(cmd: string, options?: Options & OptionsFirst & OptionsThrow): string;
    function sync(cmd: string, options: Options): string | ReadonlyArray<string> | null;

    /** Options that ask for all matches. */
    interface OptionsAll extends AsyncOptions {
        all: true;
    }

    /** Options that ask for the first match (the default behavior) */
    interface OptionsFirst extends AsyncOptions {
        all?: false;
    }

    /** Options that ask to receive null instead of a thrown error */
    interface OptionsNoThrow extends Options {
        nothrow: true;
    }

    /** Options that ask for a thrown error if executable is not found (the default behavior) */
    interface OptionsThrow extends Options {
        nothrow?: false;
    }

    /** Options for which() async API */
    interface AsyncOptions {
        /** If true, return all matches, instead of just the first one. Note that this means the function returns an array of strings instead of a single string. */
        all?: boolean;
        /** Use instead of the PATH environment variable. */
        path?: string;
        /** Use instead of the PATHEXT environment variable. */
        pathExt?: string;
    }

    /** Options for which() sync and async APIs */
    interface Options extends AsyncOptions {
        /** If true, returns null when not found */
        nothrow?: boolean;
    }
}

export = which;