原型如何在打字稿上扩展？

Question

我扩展了函数原型，但 typescript 无法识别它。

Function.prototype.proc = function() {
  var args, target, v;
  var __slice = [].slice;
  args = 1 <= arguments.length ? __slice.call(arguments, 0) : [];
  target = this;
  while (v = args.shift()) {
    target = target(v);
  }
  return target;
};
// generated by coffee-script

var foo: (number) => (string) => number
  = (a) => (b) => a * b.length;
console.log(foo.proc("first", "second"))

结果：tsc -e

The property 'proc' does not exist on value of type 'Function'

如何扩展这个对象？

Answer 1

标准 typescript 库中有一个 Function 接口，它声明了 Function 对象的成员。您需要使用您自己的附加组件将 proc 声明为该接口的成员，如下所示：

interface Function {
    proc(...args: any[]): any;
}

需要从您打算使用“proc”的任何地方引用此接口。

Answer 2

像这样：

declare global {
    interface Function {
        proc() : any;
    }
}

如果没有“声明全局”，它将不起作用。

这就是模块扩充在最近的 TypeScript 版本中的工作方式。查看documentation 并向下滚动到Module augmentation 部分。

Answer 3

静态方法

declare global { 
  interface NumberConstructor {
    formatCurrency(num: number): string;
  }
}

export const formatCurrency = (num: number) => {
  if (!num) return '$0';
  return '$' + num.toFixed(0).replace(/(\d)(?=(\d{3})+(?!\d))/g, '$1,');
};

Number.formatCurrency = formatCurrency;

非静态方法

declare global {
  interface Number {
    formatCurrency: () => string;
  }
}

Number.prototype.formatCurrency = function() : string {
  return '$' + this.toFixed(0).replace(/(\d)(?=(\d{3})+(?!\d))/g, '$1,');
}

Answer 4

只需添加一点，如果您尝试添加已声明的内容，那么这是类型安全的方式，也可以防止错误的 for in 实现。

export const augment = <U extends (string|symbol), T extends {[key :string] :any}>(
    type  :new (...args :any[]) => T,
    name  :U,
    value :U extends string ? T[U] : any
) => {
    Object.defineProperty(type.prototype, name, {writable:true, enumerable:false, value});
};

可用于安全地填充。 示例

//IE doesn't have NodeList.forEach()
if (!NodeList.prototype.forEach) {
    //this errors, we forgot about index & thisArg!
    const broken = function(this :NodeList, func :(node :Node, list :NodeList) => void) {
        for (const node of this) {
            func(node, this);
        }
    };
    augment(NodeList, 'forEach', broken);

    //better!
    const fixed = function(this :NodeList, func :(node :Node, index :number, list :NodeList) => void, thisArg :any) {
        let index = 0;
        for (const node of this) {
            func.call(thisArg, node, index++, this);
        }
    };
    augment(NodeList, 'forEach', fixed);
}

_{不幸的是，由于limitation in current TS，它无法对您的符号进行类型检查，并且如果字符串 doesn't match any definition 出于某种原因，它不会对您大喊大叫，我会在查看它们是否报告该错误'已经知道了。}

Answer 5

我添加此内容是为了建议不要添加类似示例中所示的原型，因为很多人都会查看此问题。添加如下：

interface Function {
    proc(...args: any[]): any;
}

Object.defineProperty(Function.prototype, 'proc', { value: function(arg: any[]) {
    // Your function body
}});

原因是如果你直接将它添加到原型中，如果该函数的实例被枚举了，它可能会被枚举。 for i in ..。现在这个块可能在你无法控制的代码中（最近发生在我身上），所以最好让你的代码尽可能安全。