Typescript support? - Githubissues

mokkabonna / inquirer-autocomplete-prompt

Autocomplete prompt for inquirer

ISC License

354 stars 82 forks source link

Typescript support? #107

Open alvinfebriando opened 4 years ago

alvinfebriando commented 4 years ago

How to use this library with typescript? It's said no typings were found

mokkabonna commented 4 years ago

I think it is possible to use this library with typescript without any modifications.

But I guess the type hinting for the options could be supplied. I am not familiar with typescript, so any suggestion/explanation of how this could work is welcome.

c-vetter commented 2 years ago

For those who need a quick fix until the actual types land, here's what I'm doing:

Create _inquirer-autocomplete-prompt.d.ts somewhere reachable from your code, e.g. in src, with this content:
```
declare module 'inquirer-autocomplete-prompt'
```
Add this line at the beginning of every file where you import autocomplete from 'inquirer-autocomplete-prompt':
```
/// <reference path='_inquirer-autocomplete-prompt.d.ts'/>
```
Take care of the remaining types locally

I have no errors and the whole thing works.

c-vetter commented 2 years ago

I will review the PR to help this along. Fixing it is out of scope for now, though, due to other work.

jayeeson commented 1 year ago

Type definitions are in DefinitelyTyped/inquirer-autocomplete-prompt (project page)

Just need to import @types/inquirer-autocomplete-prompt