Support non-promise function options in TypeScript #313
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
These functions don't really _need_ to be async but currently the types
require that they are. For example, currently this is an invalid option:
```typescript
onSignal: () => logger.info("signal received")
```
and instead you'd have to write:
```typescript
onSignal: async () => logger.info("signal received")
```
which might trigger a linter error such as typescript-eslint's
`Async method 'onSignal' has no 'await' expression.`
or
```typescript
onSignal: () => {
logger.info("signal received")
return Promise.resolve()
}
```
which creates a promise for no reason other than to satisfy the types!
With this PR the types make it clear that you can actually just return
nothing or, in the case of the health checks, return a value without
using async/await or creating a promise.
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.
Summary
Hey folks, thanks for the library! This is a small change to the types, with no functional changes, which should hopefully make things a tiny bit cleaner for users.
These functions don't really need to be async but currently the types require that they are. For example, currently this is an invalid option:
and instead you'd have to write:
which might trigger a linter error such as typescript-eslint's
Async method 'onSignal' has no 'await' expression.or
which creates a promise for no reason other than to satisfy the types!
With this PR the types make it clear that you can actually just return nothing or, in the case of the health checks, return a value without using async/await or creating a promise.
Changelog
Update types to support non-promise function options