Default values in combination with object destructuring are not type checked within function declarations.

TypeScript Version: 2.5.3

Code

// ===== string literal default value =====

// TS does not give an error for the default value 'z'
function defaultUsingStringLiteralWithinObject({someInput = 'z'}: {someInput?: 'x' | 'y'}) {
    console.log(someInput)
}

// but when calling the function this correctly gives TS2345 (Type 'z' is not assignable to type 'x' | 'y')
defaultUsingStringLiteralWithinObject({someInput: 'z'})

// p.s. TS correctly gives TS2322 when invalid default without object destructuring
function defaultUsingStringLiteral(someInput?: 'x' | 'y' = 'z') {
    console.log(someInput)
}

// ===== enum default value =====

enum IOtherInput {
    x = 'x',
    y = 'y'
}

// TS does not give an error for the default value 'z'
function defaultUsingEnumWithinObject({otherInput = 'z'}: {otherInput?: IOtherInput}) {
    console.log(otherInput)
}

// but when calling the function this correctly gives TS2345 (Type 'z' is not assignable to type 'IOtherInput')
defaultUsingEnumWithinObject({otherInput: 'z'})

// p.s. TS correctly gives TS2322 when invalid default without object destructuring
function defaultUsingEnum(otherInput?: IOtherInput = 'z') {
    console.log(otherInput)
}

Expected behavior:
Default values - in combination with object destructuring - should also be type checked in the function declaration.

Actual behavior:
Default values - in combination with object destructuring - are not type checked in the function declaration. Noticed this behaviour for both string literals and enums.

Your example is actually working as intended. In a construct such as

function foo({ someInput = 'z' }: { someInput?: 'x' | 'y' }) {
    // Type of someInput is 'x' | 'y' | 'z'
}

the type of someInput within the function is inferred to be 'x' | 'y' | 'z', i.e. a union of the destructuring source type and the default value type. However, the type of someInput required when you're calling the function is 'x' | 'y' | undefined. Effectively, this allows you to use a default value that isn't in the domain of the values you're allowed to pass to the function.

Thanks for the quick response!

Shouldn't the same inferred behaviour then also apply to the examples without destructuring? e.g.

type TSomeInput = 'x' | 'y'

function defaultUsingStringLiteral(someInput: TSomeInput = 'z') {
    // whatever
}

But this now gives a TS2322 : 'z' is not assignable to type 'TSomeInput'. Doesn't feel consistent.

Personally I don't immediately see a strong use case for "allows you to use a default value that isn't in the domain of the values you're allowed to pass to the function". There's functionally no difference if the user would pass the default value or not pass the variable at all.
Instead this inferred additional-allowed-value could cause unwanted situations where an old 'wrong' default value (that wasn't refactored because of no type warning and missing unit test) is still being used.

A scenario motivating the design is described in #10577. Arguably, in your example the type annotation is perhaps a stronger indication of intent, but I also think it is entirely reasonable for the default value to contribute to the eventual type. Either way, we can't break the scenario in #10577, so any change would have to accommodate both that and your example. Not sure if that is possible.

Automatically closing this issue for housekeeping purposes. The issue labels indicate that it is unactionable at the moment or has already been addressed.

Navigation Menu

Repository navigation

Default values in combination with object destructuring are not type checked within function declarations. #19127

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Default values in combination with object destructuring are not type checked within function declarations. #19127

Description

Activity

ahejlsberg commented on Oct 12, 2017

bverbist commented on Oct 12, 2017

ahejlsberg commented on Oct 12, 2017

mhegazy commented on Oct 27, 2017

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions