例如,当你想使用扩展另一个库的 JavaScript 代码时。
¥For example, when you want to work with JavaScript code which extends another library.
ts
import { greeter } from "super-greeter";// Normal Greeter APIgreeter(2);greeter("Hello world");// Now we extend the object with a new function at runtimeimport "hyper-super-greeter";greeter.hyperGreet();
“super-greeter” 的定义:
¥The definition for “super-greeter”:
ts
/*~ This example shows how to have multiple overloads for your function */export interface GreeterFunction {(name: string): void(time: number): void}/*~ This example shows how to export a function specified by an interface */export const greeter: GreeterFunction;
我们可以像下面这样扩展现有模块:
¥We can extend the existing module like the following:
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 module plugin 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'*//*~ On this line, import the module which this module adds to */import { greeter } from "super-greeter";/*~ Here, declare the same module as the one you imported above*~ then we expand the existing declaration of the greeter function*/export module "super-greeter" {export interface GreeterFunction {/** Greets even better! */hyperGreet(): void;}}
这使用 声明合并
¥This uses declaration merging
ES6 对模块插件的影响
¥The Impact of ES6 on Module Plugins
一些插件添加或修改现有模块的顶层导出。虽然这在 CommonJS 和其他加载器中是合法的,但 ES6 模块被认为是不可变的,这种模式是不可能的。因为 TypeScript 是加载器无关的,所以没有编译时强制执行此策略,但打算过渡到 ES6 模块加载器的开发者应该意识到这一点。
¥Some plugins add or modify top-level exports on existing modules. While this is legal in CommonJS and other loaders, ES6 modules are considered immutable and this pattern will not be possible. Because TypeScript is loader-agnostic, there is no compile-time enforcement of this policy, but developers intending to transition to an ES6 module loader should be aware of this.