Add TypeScript types #8
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for creating a TypeScript definition. 🙌 Can you follow this styleguide? Some examples: |
|
@sindresorhus done. |
Closed
|
|
||
| if(await isPortReachable(3000)) { | ||
| // start server | ||
| } |
There was a problem hiding this comment.
Use the same example as the readme.
index.d.ts
Outdated
| } | ||
| ``` | ||
| */ | ||
| declare function isPortReachable(port: number, opts?: {timeout?: number, host?: string}): Promise<boolean>; |
There was a problem hiding this comment.
Options should follow the style here: https://github.com/sindresorhus/typescript-definition-style-guide#documentation
|
@sindresorhus done |
sindresorhus
requested changes
Sep 19, 2021
index.d.ts
Outdated
|
|
||
| @default 1000 | ||
| */ | ||
| timeout?: number; |
index.d.ts
Outdated
| /** | ||
| Can be a domain or an IP. | ||
|
|
||
| @default localhost |
There was a problem hiding this comment.
Suggested change
| @default localhost | |
| @default 'localhost' |
package.json
Outdated
| }, | ||
| "files": [ | ||
| "index.js" | ||
| "index.js", | ||
| "index.d.ts" |
index.d.ts
Outdated
| @@ -0,0 +1,31 @@ | |||
| interface IsPortReachableOptions { | |||
There was a problem hiding this comment.
Suggested change
| interface IsPortReachableOptions { | |
| interface Options { |
|
The pull request needs a proper title. |
|
@sindresorhus done |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add typescript definition file to solve ts(7016)
Fixes #5