I have added TS to my React/Redux app.
I use window
object in my app like this:
componentDidMount() {
let FB = window.FB;
}
TS throws an error:
TypeScript error: Property 'FB' does not exist on type 'Window'. TS2339
I want to fix the error.
// Why doesn't this work? I have defined a type locally
type Window = {
FB: any
}
componentDidMount() {
let FB = window.FB;
}
// TypeScript error: Property 'FB' does not exist on type 'Window'. TS2339
I found the answer here https://stackoverflow.com/a/56402425/1114926
declare const window: any;
componentDidMount() {
let FB = window.FB;
}
// No errors, works well
Why doesn't the first version work, but the second does, even though I do not specify FB property at all?
Why does declare const window: any;
work?
Because you declare a local variable of type any
. Having something of type any
essentially turns off type checking for window
so you can do anything with it. I really do not recommend this solution, it is a really bad one.
Why doesn't type Window = { FB: any }
work?
You define a type Window
. This type if defined in a module has nothing to do with the type of the global window
object, it is just a type that happens to be called Window
inside your module.
The good solution
To extend window
you must extend the global Window
interface. You can do this like this:
declare global {
interface Window {
FB:any;
}
}
let FB = window.FB; // ok now
Note that this extension is going to be available in your whole project not just the file you define it in. Also if FB
has definitions you might consider typing it a bit better (FB: typeof import('FBOrWhateverModuleNameThisHas')
)