AsyncIterator icon indicating copy to clipboard operation
AsyncIterator copied to clipboard

Make @types/node a dependency (rather than devDependency)

Open jeswr opened this issue 2 years ago • 2 comments

If I install the asynciterator package in a new node project, then methods like .on are not shown in my type hints because TypeScript cannot guess the type of EventEmitter which AsyncIterator extends.

@types/node needs to be added as a dependency to resolve this (see https://stackoverflow.com/questions/45176661/how-do-i-decide-whether-types-goes-into-dependencies-or-devdependencies) - otherwise users of the AsyncIterator package need to install @types/node themselves

jeswr avatar Jun 01 '22 00:06 jeswr

Fine with me, but do we have a TypeScript-authoritative answer? Especially @types/node is tricky, because the actual type will not depend on the package version that we pick, but on the actual Node runtime. Is peer dependency perhaps an option?

RubenVerborgh avatar Jun 01 '22 07:06 RubenVerborgh

In Comunica, we also always include types as actual dependencies. For things such as @types/node, we use the version * range, so that the dep will always be available, but downstream users can still choose what version they use.

rubensworks avatar Jun 01 '22 07:06 rubensworks