Error TS2339: The 'email' property is not found in the 'FindUserProps' type

Question

Error TS2339: The 'email' property is not found in the 'FindUserProps' type

interface FindUserEmailProps {
   readonly email: string
}

interface FindUserIdProps {
   readonly id: string
}

type FindUserProps = FindUserEmailProps | FindUserIdProps

export const findUserByEmail = async ({ email }: FindUserProps): Promise<IUser> => {
   const user = await User.findOne({ email })
   if (!user) {
      throw new Error('User not found')
   }
   return user
}

I am experiencing an issue with the TS2339 error stating that 'Property 'email' does not exist on type 'FindUserProps'. Can anyone help explain why this is happening?

typescript express types

Answer 1

Answer №1

The reason for this behavior is that FindUserProps can only be either FindUserEmailProps or FindUserIdProps, not both simultaneously (which would require both FindUserEmailProps & FindUserIdProps). Therefore, TypeScript needs an assertion to determine which type it is.

In order to extract the email property from a FindUserProps, you must create your own type guard function to help TypeScript identify whether it's a FindUserEmailProps or FindUserIdProps.

// Custom type guard to specify if an object is FindUserEmailProps
function isFindUserEmailProps(obj: FindUserProps): obj is FindUserEmailProps {
  return "email" in obj;
}

export const findUserByEmail = async (userProps: FindUserProps): Promise<IUser> => {
   // Ensure userProps is of type FindUserEmailProps
   if (!isFindUserEmailProps(userProps)) {
      // To simplify, consider changing the function to accept only FindUserEmailProps
      throw new Error("Invalid userProps to find by email");
   }
   const {email} = userProps;
   const user = await User.findOne({ email })
   if (!user) {
      throw new Error('User not found')
   }
   return user
}

Answer 2

The reason for this behavior is that FindUserProps can only be either FindUserEmailProps or FindUserIdProps, not both simultaneously (which would require both FindUserEmailProps & FindUserIdProps). Therefore, TypeScript needs an assertion to determine which type it is.

In order to extract the email property from a FindUserProps, you must create your own type guard function to help TypeScript identify whether it's a FindUserEmailProps or FindUserIdProps.

// Custom type guard to specify if an object is FindUserEmailProps
function isFindUserEmailProps(obj: FindUserProps): obj is FindUserEmailProps {
  return "email" in obj;
}

export const findUserByEmail = async (userProps: FindUserProps): Promise<IUser> => {
   // Ensure userProps is of type FindUserEmailProps
   if (!isFindUserEmailProps(userProps)) {
      // To simplify, consider changing the function to accept only FindUserEmailProps
      throw new Error("Invalid userProps to find by email");
   }
   const {email} = userProps;
   const user = await User.findOne({ email })
   if (!user) {
      throw new Error('User not found')
   }
   return user
}

Error TS2339: The 'email' property is not found in the 'FindUserProps' type

Answer №1

Similar questions

Implement Stripe API mocking using Jest in Node.js with Typescript

Connect the child content to the form

Encountering the error message "Uncaught Promise (SyntaxError): Unexpected end of JSON input"

Can you please explain the significance of classes <T> and <U> in Angular 2?

SyntaxError in ExpressJS: Encountered an unexpected token "C"

How can you create an interface where the value type is determined by the key, but not all keys are predefined?

Locate all instances of first or last names using a single query in MongoDB

Issue TS2769: No matching overload found for this call. The type 'string | null' cannot be assigned to type 'string | string[]'

Mongoose and the concept of floating point values

Middleware in Expressjs ensures that variables are constantly updated

Problem with dynamic page routes in Next.js (and using TypeScript)

Setting configuration files in Node.js with npm configuration

What methods are available for managing errors in express at a global level without relying on try and catch blocks within my controllers

The specified type '{ state: any; dispatch: React.Dispatch<{ type: string; value: any; }>; }' is not compatible with the expected type

Converting typescript path aliases into local file paths

What is the best way to reduce the size of TypeScript source code in an Electron application with the help of Electron Forge and Electron Packager

What could be causing the issue with creating new comments in my node.js application?

Are you struggling with perplexing TypeScript error messages caused by a hyphen in the package name?

Tips on transitioning a Node.js application from JavaScript to TypeScript incrementally

Displaying notification in Ionic 2