ChatGPT解决这个技术问题 Extra ChatGPT

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

When I make any property of an interface optional, and while assigning its member to some other variable like this:

interface Person {
  name?: string,
  age?: string,
  gender?: string,
  occupation?: string,
}

function getPerson() {
  let person = <Person>{name:"John"};
  return person;
}

let person: Person = getPerson();
let name1: string = person.name; // <<< Error here 

I get an error like the following:

TS2322: Type 'string | undefined' is not assignable to type 'string'.
Type 'undefined' is not assignable to type 'string'.

How do I get around this error?


D
Dyapa Srikanth

You can now use the non-null assertion operator that is here exactly for your use case.

It tells TypeScript that even though something looks like it could be null, it can trust you that it's not:

let name1:string = person.name!; 
//                            ^ note the exclamation mark here  

That's exactly what I was looking for!
Until ESLint does not restrict usage of non-null assertion operator :)
I'm shocked such a thing needs to exist. 🤯
This is terrible advice! Instead, help the compiler figuring it out. Add a check before accessing the property, where you either throw or return if the name is not set.
Disagree with these last two comments...E.g. I'm conditionally rendering a visual element if the property exists, and attached to that element is a function which uses the property. An extra non-null check for the property inside the function is unnecessary
A
AndreFontaine

To avoid the compilation error I used

let name1:string = person.name || '';

And then validate the empty string.


What if it isn't a string but object?
If it an object then instead of ' ' it will be {}
This is something when you can do when you are chaining values and you get this sort of error Optional chain expressions can return undefined by design - using a non-null assertion is unsafe and wrong.
This is not a solution for given problem. The compiler is there to help spotting potential problems whereas an assignment like person.name || '' is just a delegation of the problem to somewhere else.
S
Sam Spencer

I know this is a kinda late, but another way besides yannick's answer to use ! is to cast it as string thus telling TypeScript: I am sure this is a string, thus converting it.

let name1:string = person.name;//<<<Error here 

to

let name1:string = person.name as string;

This will make the error go away, but if by any chance this is not a string you will get a run-time error... which is one of the reasons we are using TypeScript to ensure that the type matches and avoid such errors at compile time.


This might make the error go away, but it never changes the actual type of the variable.
I am sorry but i think you are quite mistaken there, as i have mentioned this will in fact change the type as it will throw a runtime exception if the type doesnt happen to be a string or fails to have a toString method. This will cast whatever is there into a string, i.e you have a number it will attempt to call the .toString function of whatever you have there.
But that won't be the correct way right, say if my name has number "0" in it, it would just covert it to string... Rather it should throw an error and say invalid name. Personally, I would not use this typecast and specially check for the type passed in the object .. but we all have different coding styles, open for more discussion on the same
Yes but this completely out of the context of the question that this answer was given. We do not know if this is a form if there are no steps to filter that out before hand. Also what you are suggesting there would be impossible at that stage without some really dirty workarounds.
No need for workarounds, just one check before you try to access the variable. Both cases would be handled easily, errors would go away and your code will be safer. Just try it out :)
i
igo

As of TypeScript 3.7 you can use nullish coalescing operator ??. You can think of this feature as a way to “fall back” to a default value when dealing with null or undefined

let name1:string = person.name ?? '';

The ?? operator can replace uses of || when trying to use a default value and can be used when dealing with booleans, numbers, etc. where || cannot be used.

As of TypeScript 4 you can use ??= assignment operator as a ??= b which is an alternative to a = a ?? b;


A
Ali80

By your definition Person.name can be null but name1 cannot. there are two scenarios:

Person.name is never null

tell the compiler your are sure the name is not null by using !

let name1: string = person.name!;

Person.name can be null

specify a default value in case name is null

let name1: string = person.name ?? "default name";

g
goldins

A more production-ready way to handle this is to actually ensure that name is present. Assuming this is a minimal example of a larger project that a group of people are involved with, you don't know how getPerson will change in the future.

if (!person.name) {
    throw new Error("Unexpected error: Missing name");
}

let name1: string = person.name;

Alternatively, you can type name1 as string | undefined, and handle cases of undefined further down. However, it's typically better to handle unexpected errors earlier on.

You can also let TypeScript infer the type by omitting the explicit type: let name1 = person.name This will still prevent name1 from being reassigned as a number, for example.


K
Konkret

Here's a quick way to get what is happening:

When you did the following:

name? : string

You were saying to TypeScript it was optional. Nevertheless, when you did:

let name1 : string = person.name; //<<<Error here 

You did not leave it a choice. You needed to have a Union on it reflecting the undefined type:

let name1 : string | undefined = person.name; //<<<No error here 

Using your answer, I was able to sketch out the following which is basically, an Interface, a Class and an Object. I find this approach simpler, never mind if you don't.

// Interface
interface iPerson {
    fname? : string,
    age? : number,
    gender? : string,
    occupation? : string,
    get_person?: any
}

// Class Object
class Person implements iPerson {
    fname? : string;
    age? : number;
    gender? : string;
    occupation? : string;
    get_person?: any = function () {
        return this.fname;
    }
}

// Object literal
const person1 : Person = {
    fname : 'Steve',
    age : 8,
    gender : 'Male',
    occupation : 'IT'  
}

const p_name: string | undefined = person1.fname;

// Object instance 
const person2: Person = new Person();
person2.fname = 'Steve';
person2.age = 8;
person2.gender = 'Male';
person2.occupation = 'IT';

// Accessing the object literal (person1) and instance (person2)
console.log('person1 : ', p_name);
console.log('person2 : ', person2.get_person());

佚名

try to find out what the actual value is beforehand. If person has a valid name, assign it to name1, else assign undefined.

let name1: string = (person.name) ? person.name : undefined;

hmmm. That will be too verbose if I want to do multiple assignments. Is there a way to turn off this particular warning?
unfortunately not except you make name mandatory by removing the question mark.
PS: Which version of TypeScript do you use? I use 3.2.4 and do not run into this Message. In my test class the code perectly compiles.
same version. I get this error in webstorm but not in vscode
That is strange, because I use IntelliJ which is supposed to be similar to WebStorm when it comes to application of TS-rules?!
N
NearHuscarl

Solution 1: Remove the explicit type definition

Since getPerson already returns a Person with a name, we can use the inferred type.

function getPerson(){
  let person = {name:"John"};
  return person;
}

let person = getPerson();

If we were to define person: Person we would lose a piece of information. We know getPerson returns an object with a non-optional property called name, but describing it as Person would bring the optionality back.

Solution 2: Use a more precise definition

type Require<T, K extends keyof T> = T & {
  [P in K]-?: T[P]
};

function getPerson() {
  let person = {name:"John"};
  return person;
}

let person: Require<Person, 'name'> = getPerson();
let name1:string = person.name;

Solution 3: Redesign your interface

A shape in which all properties are optional is called a weak type and usually is an indicator of bad design. If we were to make name a required property, your problem goes away.

interface Person {
  name:string,
  age?:string,
  gender?:string,
  occupation?:string,
}

H
Hadi R.

if you want to have nullable property change your interface to this:

interface Person {
  name?:string | null,
  age?:string | null,
  gender?:string | null,
  occupation?:string | null,
 }

if being undefined is not the case you can remove question marks (?) from in front of the property names.


Hi, I know its been a while. What if this interface is a parameter to a function. How do i pass the parameter. Would just passing something like this work { } , Thanks in advance for the help.
@vigneshasokan: An interface type cannot be passed as a parameter.
T
Taynã Davantel Costa

You can do like this!

let name1:string = `${person.name}`;

but remember name1 can be an empty string


This is the only answer that worked for me. I'm trying to do <div style={{color:this.props.color}}>text</div>. This is so weird.
D
Dmitry Lobov

You trying to set variable name1, witch type set as strict string (it MUST be string) with value from object field name, witch value type set as optional string (it can be string or undefined, because of question sign). If you really need this behavior, you have to change type of name1 like this:

let name1: string | undefined = person.name;

And it'll be ok;


И
Илья Зеленько

You can use the NonNullable Utility Type:

Example

type T0 = NonNullable<string | number | undefined>;  // string | number
type T1 = NonNullable<string[] | null | undefined>;  // string[]

Docs.


B
Benny Neugebauer

If you remove the <Person> casting from your getPerson function, then TypeScript will be smart enough to detect that you return an object which definitely has a name property.

So just turn:

interface Person {
  name?: string,
  age?: string,
  gender?: string,
  occupation?: string,
}

function getPerson() {
  let person = <Person>{name: 'John'};
  return person;
}

let person: Person = getPerson();
let name1: string = person.name;

Into:

interface Person {
  name?: string,
  age?: string,
  gender?: string,
  occupation?: string,
}

function getPerson() {
  let person = {name: 'John'};
  return person;
}

let person = getPerson();
let name1: string = person.name;

If you cannot do that, then you will have to use the "definite assignment assertion operator" as @yannick1976 suggested:

let name1: string = person.name!;

What's the point of having an interface and not using it for typing?
M
Mithsew

This was the only solution I found to check if an attribute is undefined that does not generate warnings

type NotUndefined<T, K extends keyof T> = T & Record<K, Exclude<T[K], undefined>>;
function checkIfKeyIsDefined<T, K extends keyof T>(item: T, key: K): item is NotUndefined<T, K> {
    return typeof item === 'object' && item !== null && typeof item[key] !== 'undefined';
}

usage:


interface Listing { 
    order?: string
    ...
}
obj = {..., order: 'pizza'} as Listing
if(checkIfKeyIsDefined(item: obj, 'order')) {
    order.toUpperCase() //no undefined warning O.O
}

original answer


s
sardor khaydarov
  @Input()employee!:string ;`enter code here`
announced:boolean=false;
confirmed:boolean=false;
task:string="<topshiriq yo'q>";

  constructor(private taskService:TaskService ) {
    taskService.taskAnnon$.subscribe(
      task => {
        this.task=task;
        this.announced=true;
        this.confirmed=false;
      }
    )
  }

  ngOnInit(): void {
  }
  confirm(){
   this.confirmed=true
this.taskService.confirimTask(this.employee);`enter code here`
  }
}

Your answer could be improved with additional supporting information. Please edit to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers in the help center.
I don't see how this answers the question at all, just looks like random code to me. I've voted this answer down but happy to change that if the answer is updated in some way.
R
Ros

Had the same issue.

I find out that react-scrips add "strict": true to tsconfig.json.

After I removed it everything works great.

Edit

Need to warn that changing this property means that you:

not being warned about potential run-time errors anymore.

as been pointed out by PaulG in comments! Thank you :)

Use "strict": false only if you fully understand what it affects!


This may 'work'. But it only works in the sense that you're not being warned about potential run time errors anymore. I'd encourage research on what the strict checking in Typescript does : medium.com/webhint/going-strict-with-typescript-be3f3f7e3295
I should mention that the OP asked, "How do I get around this error?" not, "How do I fix this issue?"
Simply adding name:string = undefined (as recommended by packages like json2typescript) will throw error 2322 unless you turn strict off, which is what most people will need to do. This accepted answer is clear, correct, and deserves many more votes.