如何在TypeScript中显式地设置window的新属性?

我通过显式设置窗口上的属性为我的对象设置全局名称空间。

window.MyNamespace = window.MyNamespace || {};

TypeScript强调MyNamespace，并抱怨:

属性“MyNamespace”在类型为“window”的值上不存在任何“

我可以通过将MyNamespace声明为环境变量并删除窗口显式来使代码工作，但我不想这样做。

declare var MyNamespace: any;

MyNamespace = MyNamespace || {};

我如何保持窗口在那里，让TypeScript满意?

作为旁注，我发现特别有趣的是，TypeScript抱怨，因为它告诉我，窗口的类型是any，它肯定可以包含任何东西。

当前回答

完整和简短的回答

1-在tsconfig.json中添加typeRoots属性:

{
  "compilerOptions": {
    ...
    "typeRoots": ["src/@types", "node_modules/@types"]
    ...
  }
}

2-扩展窗口类型

// file: src/@types/global.d.ts

declare global {
    interface Window { customProperty: <type>; }
}

其他回答

接受的答案是我过去使用的，但使用的是TypeScript 0.9。它不再工作了。Window接口的新定义似乎完全取代了内置定义，而不是增强它。

相反，我开始这样做:

interface MyWindow extends Window {
    myFunction(): void;
}

declare var window: MyWindow;

更新:与TypeScript 0.9.5接受的答案再次工作。

TypeScript阻止在没有指定具有所需属性或类型的情况下访问对象已经分配给了any，所以你可以使用可选的链接:

window?.MyNamespace =  'value'

我刚刚在另一个Stack Overflow问题的答案中找到了这个问题的答案。

declare global {
    interface Window { MyNamespace: any; }
}

window.MyNamespace = window.MyNamespace || {};

基本上，您需要扩展现有的窗口界面来告诉它您的新属性。

对于那些想要在窗口对象上设置计算或动态属性的人，你会发现使用declare global方法是不可能的。来阐明这个用例

window[DynamicObject.key] // Element implicitly has an 'any' type because type Window has no index signature

你可以尝试这样做

declare global {
  interface Window {
    [DyanmicObject.key]: string; // error RIP
  }
}

但上面的操作会出错。这是因为在TypeScript中，接口不能很好地使用计算属性，并且会抛出类似于

A computed property name in an interface must directly refer to a built-in symbol

为了解决这个问题，你可以按照建议将窗口转换为<any>

(window as any)[DynamicObject.key]

如果你使用的是TypeScript 3。X，你可以在其他答案中省略声明全局部分，而只是使用:

interface Window {
  someValue: string
  another: boolean
}

当我使用TypeScript 3.3、Webpack和TSLint时，这种方法很有效。

推荐文章