[Typescript] Improve types for isKafkaJSError - #498
Open
Leo Singer (lpsinger) wants to merge 1 commit into
Open
Conversation
Leo Singer (lpsinger)
force-pushed
the
isKafkaJSError-type-predicate
branch
from
June 23, 2026 12:22
4a28b57 to
9605d94
Compare
Change the input parameter's type from `Error` to `any`. Now you
no longer have to write this to silence all type errors:
```typescript
try {
// ...
} catch (e) {
if (e instanceof Error && isKafkaJSError(e) {
// ...
}
}
```
Now you can simply write:
```typescript
try {
// ...
} catch (e) {
if (isKafkaJSError(e)) {
// ...
}
}
```
Declare it as a type predicate so that TypeScript understands that
if the function returns `true` that it narrows the type to
`KafkaJSError`.
Leo Singer (lpsinger)
force-pushed
the
isKafkaJSError-type-predicate
branch
from
July 20, 2026 18:41
9605d94 to
d28ab2a
Compare
This file contains hidden or 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
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.
Change the input parameter's type from
Errortoany. Now you no longer have to write this to silence all type errors:Now you can simply write:
Declare it as a type predicate so that TypeScript understands that if the function returns
truethat it narrows the type toKafkaJSError.Please prefix all TypeScript pull-requests with
[Typescript]What
Checklist
References
JIRA:
Test & Review
Open questions / Follow-ups