global-modifying-module.d.ts

修改了全局作用域的模块

对于修改了全局作用域的模块来讲，在导入它们时，会对全局作用域中的值进行修改。 比如存在某个代码库，当导入它时，它会向String.prototype上添加新的成员。 该模式存在危险，因为它有导致运行时冲突的可能性， 但我们仍然可以为其编写声明文件。

识别出修改了全局作用域的模块

我们可以通过文档来识别修改了全局作用域的模块。 通常来讲，它们与全局插件类似，但是需要require语句来激活。

你可能看到过如下的文档：

  1. // 'require' call that doesn't use its return value
  2. var unused = require('magic-string-time');
  3. /* or */
  4. require('magic-string-time');
  6. var x = 'hello, world';
  7. // Creates new methods on built-in types
  8. console.log(x.startsWithHello());
  10. var y = [1, 2, 3];
  11. // Creates new methods on built-in types
  12. console.log(y.reverseAndSort());

以下是一个示例：

  1. // Type definitions for [~THE LIBRARY NAME~] [~OPTIONAL VERSION NUMBER~]
  2. // Project: [~THE PROJECT NAME~]
  3. // Definitions by: [~YOUR NAME~] <[~A URL FOR YOU~]>
  5. /*~ This is the global-modifying module template file. You should rename it to index.d.ts
  6.  *~ and place it in a folder with the same name as the module.
  7.  *~ For example, if you were writing a file for "super-greeter", this
  8.  *~ file should be 'super-greeter/index.d.ts'
  9.  */
  11. /*~ Note: If your global-modifying module is callable or constructable, you'll
  12.  *~ need to combine the patterns here with those in the module-class or module-function
  13.  *~ template files
  14.  */
  15. declare global {
  16.     /*~ Here, declare things that go in the global namespace, or augment
  17.      *~ existing declarations in the global namespace
  18.      */
  19.     interface String {
  20.         fancyFormat(opts: StringFormatOptions): string;
  21.     }
  22. }
  24. /*~ If your module exports types or values, write them as usual */
  25. export interface StringFormatOptions {
  26.     fancinessLevel: number;
  27. }
  29. /*~ For example, declaring a method on the module (in addition to its global side effects) */
  30. export function doSomething(): void;
  32. /*~ If your module exports nothing, you'll need this line. Otherwise, delete it */
  33. export {};