search

coopernurse / node-pool

Generic resource pooling for node.js
2.37k stars 259 forks source link

Fix typo annotations in JSDoc with TypeScript #218

Closed geovanisouza92 closed 6 years ago

geovanisouza92 commented 6 years ago

Hi, thanks for this amazing lib!

This PR enable TypeScript to enhance type checking and experience for TS users (me included).

There are some small typos that I think can cause bugs here and there, I'll flag them on comments.

I think that migrate to TS can enhance even more the quality of the lib, and if you agree, I can make another PR later.

sandfox commented 6 years ago

Thanks so much for all this, the original docblocks were just what I put together whilst doing the rewrite to help at the time, but I never actually used them for anything. The current state of the project is more of an evolution than designed from scratch effort. I'm not against using TS or Flow, but I'd rather do it with the next iteration of the library which had a well thought out api.

I'd be up for a adding some easy way to test/check the docblocks work with TS, do you have any suggestions?

geovanisouza92 commented 6 years ago

@sandbox this PR adds type checking with TS without rewriting. It's why it have a tsconfig and TS installed.