Installation

npm install --save @types/inquirer-fuzzy-path

Summary

This package contains type definitions for inquirer-fuzzy-path (https://github.com/adelsz/inquirer-fuzzy-path).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/inquirer-fuzzy-path.

index.d.ts

1import { Answers, KeyUnion, QuestionCollection } from "inquirer";
2import { AutocompleteQuestionOptions } from "inquirer-autocomplete-prompt";
3import InquirerAutocomplete = require("inquirer-autocomplete-prompt");
4import { Interface as ReadlineInterface } from "readline";
5
6export = InquirerFuzzyPath;
7
8/**
9 * Provides the functionality to create a new Inquirer plugin
10 */
11declare class InquirerFuzzyPath<T extends Answers> extends InquirerAutocomplete<T> {
12    /**
13     * Create new InquirerFuzzyPath
14     *
15     * @param questions
16     * The questions to prompt
17     * @param rl
18     * The readline interface
19     * @param answers
20     * The currently supplied answers
21     */
22    constructor(questions: QuestionCollection<T>, rl: ReadlineInterface, answers: Answers);
23
24    /**
25     * Curate list of choices.
26     *
27     * @param searchTerm
28     * The term to search for
29     */
30    search(searchTerm: string): Promise<void>;
31
32    /**
33     * When user presses `enter` key
34     *
35     * @param line
36     * The input on the line.
37     */
38    onSubmit(line: string): void;
39}
40
41/**
42 * Provides inquirer prompt options for type `InquirerFuzzyPath`.
43 */
44declare namespace InquirerFuzzyPath {
45    /**
46     * Provides options for a question of type `InquirerFuzzyPath`.
47     *
48     * @template T
49     * The type of the answers.
50     */
51    interface FuzzyPathQuestionOptions<T extends Answers = Answers>
52        extends Partial<Omit<AutocompleteQuestionOptions<T>, "type">>
53    {
54        /**
55         * The key to save the answer to the answers-hash.
56         */
57        type: "fuzzypath";
58
59        /**
60         * The key to save the answer to the answers-hash.
61         */
62        name: KeyUnion<T>;
63
64        /**
65         * The root search directory, default to ".".
66         */
67        rootPath?: string | undefined;
68
69        /**
70         * A function to exclude some paths from the file-system scan.
71         */
72        excludePath?: ((path: string) => boolean) | undefined;
73
74        /**
75         * A function to exclude some paths from the final list.
76         */
77        excludeFilter?: ((path: string) => boolean) | undefined;
78
79        /**
80         * A string to specify the type of nodes to display, default to "any".
81         */
82        itemType?: "any" | "directory" | "file" | undefined;
83
84        /**
85         * An integer (>= 0) to limit the depth of sub-folders to scan,
86         * undefined means infinite.
87         */
88        depthLimit?: number | undefined;
89    }
90}
91

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: @types/inquirer, @types/inquirer-autocomplete-prompt

Credits

These definitions were written by 迷子 (Maiko Tan).