Skip to content

Object spreads should retain shallow type narrowing #26645

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

TypeScript Version: 3.1.0-dev.20180822

Search Terms: object spread assignability inference equals undefined throw error assignable

Code

interface IModel {
    index?: number;
}

function fillOut(model: IModel) {
    if (model.index === undefined) {
        throw new Error("");
    }

    const index: number = model.index; // OK

    const directModel: Required<IModel> = model;
//        ~~~~~~~~~~~ 
//  Type 'IModel' is not assignable to type 'Required<IModel>'.
//    Property 'index' is optional in type 'IModel' but required in type 'Required<IModel>'.

    const spreadModel: Required<IModel> = {
//        ~~~~~~~~~~~ 
//  Type 'IModel' is not assignable to type 'Required<IModel>'.
//    Property 'index' is optional in type 'IModel' but required in type 'Required<IModel>'.
        ...model,
        // index: 0,
    };
}

Expected behavior:

spreadModel should be allowed, as we've inferred that model.index must be of type number, and unlike directModel, there's no allowed way to modify spreadModel after the fact.

Actual behavior:

The type narrowing on model is forgotten in the ... spread.

Playground Link: http://www.typescriptlang.org/play/#src=interface%20IModel%20%7B%0D%0A%20%20%20%20index%3F%3A%20number%3B%0D%0A%7D%0D%0A%0D%0Afunction%20fillOut(model%3A%20IModel)%20%7B%0D%0A%20%20%20%20if%20(model.index%20%3D%3D%3D%20undefined)%20%7B%0D%0A%20%20%20%20%20%20%20%20throw%20new%20Error(%22%22)%3B%0D%0A%09%7D%0D%0A%0D%0A%09const%20index%3A%20number%20%3D%20model.index%3B%0D%0A%0D%0A%20%20%20%20const%20directModel%3A%20Required%3CIModel%3E%20%3D%20model%3B%0D%0A%0D%0A%20%20%20%20const%20spreadModel%3A%20Required%3CIModel%3E%20%3D%20%7B%0D%0A%20%20%20%20%20%20%20%20...model%2C%0D%0A%20%20%20%20%20%20%20%20%2F%2F%20index%3A%200%2C%0D%0A%20%20%20%20%7D%3B%0D%0A%7D%0D%0A

Metadata

Metadata

Assignees

No one assigned

    Labels

    DuplicateAn existing issue was already created

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions