Skip to content

Conversation

@bigmontz
Copy link
Contributor

@bigmontz bigmontz commented Dec 5, 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 miss-match in runtime will not trigger errors.

@robsdedude robsdedude self-requested a review December 6, 2022 10:57
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.
@bigmontz bigmontz force-pushed the 5.x-add-typescript-typeguard-to-isTypeMethods branch from 2ac57dd to 04c4fda Compare December 16, 2022 09:02
Copy link
Member

@robsdedude robsdedude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔎

@bigmontz bigmontz merged commit 3db98f5 into neo4j:5.0 Dec 16, 2022
@bigmontz bigmontz deleted the 5.x-add-typescript-typeguard-to-isTypeMethods branch December 16, 2022 13:08
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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants