Inspecting a union type with a TypeScript property validation

Question

Inspecting a union type with a TypeScript property validation

I have defined a union of two types in my code. Here are the definitions:

type Generic = {
  subtype: undefined,
  user: string,
  text: string
}

type Other = {
  subtype:'message',
  text: string
}

type Message = Generic | Other;

Within my code, I am using the following condition:

function getMessage(event: Message) {
  if (event.subtype === undefined) console.log(event.user); // This should work because only Generic has subtype === undefined and it has a user property
}

However, when running this code, TypeScript raises an error stating

Property user does not exist on type Message

. Shouldn't it work since it is within the if condition that checks for subtype? How can I resolve this issue, especially if these type definitions come from a library over which I have no control?

typescript

Answer 1

Answer №1

Whether the below code works correctly depends on the setting of strictNullChecks in the TypeScript configuration: if strictNullChecks is set to true, then it functions as intended.

 function getMessage(event: Message) {
       if (event.subtype === 'message'){
          console.log(event.user);
       }
 }

However, if strictNullChecks is set to false, you will need to use the as operator like this:

function getMessage(event: Message) {
  if (event.subtype === 'message'){
      console.log((event as Generic).user);
  }
}

Here is a working example.

Answer 2

Whether the below code works correctly depends on the setting of strictNullChecks in the TypeScript configuration: if strictNullChecks is set to true, then it functions as intended.

 function getMessage(event: Message) {
       if (event.subtype === 'message'){
          console.log(event.user);
       }
 }

However, if strictNullChecks is set to false, you will need to use the as operator like this:

function getMessage(event: Message) {
  if (event.subtype === 'message'){
      console.log((event as Generic).user);
  }
}

Here is a working example.

Inspecting a union type with a TypeScript property validation

Answer №1

Similar questions

What is the process for choosing a specific id from a JSON structure?

The functionality of the Auth0 Logout feature has ceased to work properly following the

Is it possible to integrate the Firestore npm library into my Express application?

A guide to finding the mean in Angular by utilizing JSON information

Issue with triggering Observable during an Angular 2 HTTP call

Loading dynamic content within Angular Material tabs allows for a more customized and interactive user experience

The type of the element is implicitly set to 'any' because the expression 'keyof IMyObj' cannot be used to index the type

Can a type be referenced using the generic name?

Encountered a style group error 'non-collision' while using Angular with HERE Maps JS API 3.1

Using Symbol.iterator in Typescript: A step-by-step guide

Maintain the nullability of object fields when casting

Can TypeScript provide a way to declare that a file adheres to a particular type or interface?

Organize library files into a build directory using yarn workspaces and typescript

Error: Type '() => () => Promise<void>' is not compatible with type 'EffectCallback'

Sharing API data between components in Angular 5

Converting lengthy timestamp for year extraction in TypeScript

What exactly does "tsc" stand for when I compile TypeScript using the command "(tsc greeter.ts)"?

Protractor Browser Instance Failure

Using React, PIXI, and Zustand can sometimes lead to stale state issues when handling mouse events

In order to access the localStorage from a different component, a page refresh is required as it is