Typescript - Generic function with an optional parameter

Question

I have some trouble trying to type a generic function with an optional parameter

type Action<TParameters = undefined> = (parameters: TParameters) => void

const A: Action = () => console.log('Hi :)') 
// Ok, as expected

const B: Action<string> = (word: string) => console.log('Hello', word)  
// Ok, as expected

const C: Action<string> = (word: number) => console.log('Hello', word)  
// Error, as expected

const D: Action<string> = () => console.log('Hello')  
// Hum, what ?!? No error ?

const E: Action<string> = (word) => console.log('Hello', word)  
// No error as expected but the type inference of `word` is `any`, why ?

Test it yourself

word is string in the final example you posted (see the test it yourself link). — David Sherret
– David Sherret, Commented Sep 25, 2017 at 14:09

Oblosys · Accepted Answer · 2017-09-25 14:50:03Z

2

The reason why D type checks is that ignoring extra parameters happens often in JavaScript. With regard to the parameters, a function f is considered a subtype of a function g as long as each parameter of f is compatible with the corresponding parameter of g. Any extra arguments in f are ignored. See 'Comparing two functions' in https://www.typescriptlang.org/docs/handbook/type-compatibility.html

(And as noted by @david-sherret, E works as you would expect, with word: string.)

answered Sep 25, 2017 at 14:50

Oblosys

15.2k3 gold badges33 silver badges41 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Typescript - Generic function with an optional parameter

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related