Add TypeScript definition #17
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 the PR, but I'm not interested in JSDoc. However, I'm happy to accept TypeScript types if you follow this styleguide? Some examples: |
|
Sure, I can do that! Please have a look now :) |
sindresorhus
requested changes
Jan 14, 2021
package.json
Outdated
| "xo": "^0.26.1" | ||
| }, | ||
| "types": "index.d.ts", |
index.test-d.ts
Outdated
| import setupElectronReloader = require('.'); | ||
|
|
||
| expectType<void>(setupElectronReloader(module)); | ||
| expectType<void>(setupElectronReloader(module, { watchRenderer: true })); |
There was a problem hiding this comment.
Suggested change
| expectType<void>(setupElectronReloader(module, { watchRenderer: true })); | |
| expectType<void>(setupElectronReloader(module, {watchRenderer: true})); |
index.d.ts
Outdated
| * @param options.watchRenderer - Watch files used in the renderer process and reload the window when they change. Defaults to `true`. | ||
| * @param options.debug - Prints watched paths and when files change. Can be useful to make sure you set it up correctly. | ||
| * @param options.ignore - Ignore patterns passed to [`chokidar`](https://github.com/paulmillr/chokidar#path-filtering). By default, files/directories starting with a `.`, `.map` files, and `node_modules` directories are ignored. This option is additive to those. | ||
| * |
index.d.ts
Outdated
| */ | ||
| declare function setupElectronReloader( | ||
| moduleObject: NodeModule, | ||
| options?: { |
There was a problem hiding this comment.
Options should be a separate type and each option should have doc comments copied from the readme. See the guidelines.
index.d.ts
Outdated
| * setupElectronReloader(module, { ignore: [ 'client/src' ] }); | ||
| * } catch (error) { | ||
| * console.error('Unable to setup reloading', error); | ||
| * } |
There was a problem hiding this comment.
Use the example from the readme.
|
I've implemented the suggestions from your comments and think that it's ready for the second round 👍 |
|
Thanks :) |
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.
This PR adds TypeScript definition for better developer experience (suggestions in the editor).