Verify in Typescript if there is at least one value supplied

Question

Verify in Typescript if there is at least one value supplied

Looking for a solution:

function takeOneOfOrThrow(firstOptionalVariable : string | undefined, secondOptionalVariable : string | undefined) {
    let result : string; 

    if (!firstOptionalVariable && !secondOptionalVariable) {
        throw new Error('both are undefined'); 
    } 
    result = firstOptionalVariable ? firstOptionalVariable : secondOptionalVariable; 
};

Check out the code in this playground: https://tsplay.dev/mxJoxw.

The two variables can be either strings or undefined. The first "if" statement ensures that at least one of them is a non-empty string. So, why does TypeScript give an error stating

Type 'string | undefined' is not assignable to type 'string'

? What would be the correct approach to solve this issue?

typescript

Answer 1

Answer №1

The compiler cannot determine the types based on your condition.

Your condition is checking if both variables are undefined, but even if one of them is not undefined, there is no way for the compiler to accurately infer the correct type for them. It wouldn't make sense to assign both as string since that's not what the condition is checking for. The compiler also cannot infer only one as string because it won't know until runtime which one will not be empty. This lack of a clear relationship between variables causes the error when trying to assign to a variable.

One solution is to use the non-null assertion operator as mentioned in another answer. However, it is advisable to avoid using it because if the function body changes and the condition is removed, the compiler won't detect any errors.

A simple alternative is to set a default value if both variables are empty, assuming that the default value won't be used due to the condition:

result = first ?? second ?? ''

Alternatively, you can utilize if/else blocks:

function takeOneOfOrThrow(firstOptionalVariable: string | undefined, secondOptionalVariable?: string | undefined) {
    let result: string;

    if (!firstOptionalVariable && !secondOptionalVariable) {
        throw new Error('both are undefined');
    }
    else if (firstOptionalVariable) {
        result = firstOptionalVariable;
    } else if (secondOptionalVariable) {
        result = secondOptionalVariable
    }
};

Answer 2

The compiler cannot determine the types based on your condition.

Your condition is checking if both variables are undefined, but even if one of them is not undefined, there is no way for the compiler to accurately infer the correct type for them. It wouldn't make sense to assign both as string since that's not what the condition is checking for. The compiler also cannot infer only one as string because it won't know until runtime which one will not be empty. This lack of a clear relationship between variables causes the error when trying to assign to a variable.

One solution is to use the non-null assertion operator as mentioned in another answer. However, it is advisable to avoid using it because if the function body changes and the condition is removed, the compiler won't detect any errors.

A simple alternative is to set a default value if both variables are empty, assuming that the default value won't be used due to the condition:

result = first ?? second ?? ''

Alternatively, you can utilize if/else blocks:

function takeOneOfOrThrow(firstOptionalVariable: string | undefined, secondOptionalVariable?: string | undefined) {
    let result: string;

    if (!firstOptionalVariable && !secondOptionalVariable) {
        throw new Error('both are undefined');
    }
    else if (firstOptionalVariable) {
        result = firstOptionalVariable;
    } else if (secondOptionalVariable) {
        result = secondOptionalVariable
    }
};

Verify in Typescript if there is at least one value supplied

Answer №1

Similar questions

Error TS[2339]: Property does not exist on type '() => Promise<(Document<unknown, {}, IUser> & Omit<IUser & { _id: ObjectId; }, never>) | null>'

Outputting double columns with Typescript Sequelize associations

Uh-oh! A circular dependency has been detected in the Dependency Injection for UserService. Let's untangle this web and fix the issue!

Unit tests are failing to typecast the Angular HTTP GET response in an observable

Exporting symbols within the same namespace from multiple files in a TypeScript project

What's the deal with the `return of ()` syntax?

Creating a Robust Next.js Build with Tailor-Made Server (Nest.js)

What is preventing typescript from inferring these linked types automatically?

Tips for calculating the total sum of inner object property values using JavaScript, TypeScript, or Angular 5

Error code 2769 in Typescript occurs when attempting to transfer process information to the data state in order to utilize it within a modal

Angular TypeScript test checking file size with Jasmine

Specify the object key type when using a `for-in` loop

Is it necessary to compile the ngfactory files during Angular 2 AOT compilation?

Error: An unexpected character (.) was encountered | Building with npm has failed

Is it possible to pass a variable to a text constant in Angular?

Unable to prolong TypeScript document

Is it possible to remove a complete row in Angular 2 using Material Design

What is the best way to retrieve the value of an input field in React when incorporating Material UI components?

Child component experiencing issues with Materialize Pagination and Sorting functionalities not functioning

Is it possible to identify and differentiate objects based on their interface types in JavaScript/TypeScript?