グローバル: モジュールの変更

グローバル変更モジュール

グローバル変更モジュールは、インポートされるとグローバルスコープの既存の値を変更します。たとえば、インポート時にString.prototypeに新しいメンバーを追加するライブラリが存在する可能性があります。このパターンは、実行時競合の可能性があるためやや危険ですが、それでも宣言ファイルを記述できます。

グローバル変更モジュールの識別

グローバル変更モジュールは、一般的にドキュメントから簡単に識別できます。一般に、グローバルプラグインに似ていますが、効果を有効にするためにrequire呼び出しが必要です。

次のようなドキュメントが表示される場合があります

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

以下に例を示します

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