-
Notifications
You must be signed in to change notification settings - Fork 151
Add and Improve type guards for is
methods
#1037
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bigmontz
merged 4 commits into
neo4j:5.0
from
bigmontz:5.x-add-typescript-typeguard-to-isTypeMethods
Dec 16, 2022
Merged
Add and Improve type guards for is
methods
#1037
bigmontz
merged 4 commits into
neo4j:5.0
from
bigmontz:5.x-add-typescript-typeguard-to-isTypeMethods
Dec 16, 2022
Conversation
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
robsdedude
reviewed
Dec 6, 2022
bigmontz
commented
Dec 12, 2022
The following methods were update to include type-guards and improve the generics over when using the type-guards: * isNode * isRelationship * isUnboundRelationship * isPath * isPathSegment * isPoint * isDuration * isLocalTime * isTime * isDate * isLocalDateTime * isDateTime Usage example without generics: ``` function handleDuration(duration: unknown) { if (isDuration(duration)) { // from this point i can access the duration properties // and methods without issue const months: Integer = duration.months } else { // this is not a duration object // @ts-expect-error const months = duration.months } } ``` Usage example with generics: ``` function handleDuration(duration: unknown) { if (isDuration<number>(duration)) { // from this point i can access the duration properties // and methods without issue const months: number = duration.months // @ts-expect-error const intMonths: Integer = duration.months } else { // this is not a duration object // @ts-expect-error const months = duration.months } } ```⚠️ Generic types missmatch in runtime will not trigger errors.
2ac57dd
to
04c4fda
Compare
robsdedude
reviewed
Dec 16, 2022
Co-authored-by: Robsdedude <dev@rouvenbauer.de>
robsdedude
approved these changes
Dec 16, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔎
bigmontz
added a commit
to bigmontz/neo4j-javascript-driver
that referenced
this pull request
Jan 9, 2023
* Add and Improve type guards for `is` methods The following methods were update to include type-guards and improve the generics over when using the type-guards: * isNode * isRelationship * isUnboundRelationship * isPath * isPathSegment * isPoint * isDuration * isLocalTime * isTime * isDate * isLocalDateTime * isDateTime Usage example without generics: ``` function handleDuration(duration: unknown) { if (isDuration(duration)) { // from this point i can access the duration properties // and methods without issue const months: Integer = duration.months } else { // this is not a duration object // @ts-expect-error const months = duration.months } } ``` Usage example with generics: The following methods were update to include type-guards and improve the generics over when using the type-guards: * isNode * isRelationship * isUnboundRelationship * isPath * isPathSegment * isPoint * isDuration * isLocalTime * isTime * isDate * isLocalDateTime * isDateTime Usage example without generics: ```typescript function handleDuration(duration: unknown) { if (isDuration(duration)) { // from this point i can access the duration properties // and methods without issue const months: Integer = duration.months } else { // this is not a duration object // @ts-expect-error const months = duration.months } } ``` Usage example with generics: ```typescript function handleDuration(duration: unknown) { if (isDuration<number>(duration)) { // from this point i can access the duration properties // and methods without issue const months: number = duration.months // @ts-expect-error const intMonths: Integer = duration.months } else { // this is not a duration object // @ts-expect-error const months = duration.months } } ```⚠️ Generic types miss-match in runtime will not trigger errors. Co-authored-by: Robsdedude <dev@rouvenbauer.de>
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.
The following methods were update to include type-guards and improve the generics over when using the type-guards:
Usage example without generics:
Usage example with generics: