使用 Coffeescript 公开 javascript api

Question

我最近开始使用 Coffeescript，并且很好奇将我使用 Coffeescript 创建的对象公开给其他 javascript 页面的“正确”方法是什么。由于咖啡脚本包装功能，调用 window.coffeeObject = externalObject 的行为是否可接受。

示例

example.coffee

externalObject = 
   method1: -> 'Return value'
   method2: -> 'Return method2'

window.myApi = externalObject

编译

(function() {
  var externalObject;
  externalObject = {
    method1: function() {
      return 'Return value';
    },
    method2: function() {
      return 'Return method2';
    }
  };
  window.myApi = externalObject;
}).call(this);

example.js -- 从 example.coffee other.js

alert(myApi.method1()) // Should return "Return value"

Answer 1

是的，这是正确的。或者，您可以使用define @myApi = { foo: -> } 因为 this 是文件根上下文中的 window。

Answer 2

您可以进一步简化语法，例如，如果您有 2 个内部函数

example.coffee

myPrivateFunction = ->
    "return 1"

myPrivateFunction2 = ->
    "return 2"

@myApi = {
    myFunction : myPrivateFunction,
    myFunction2 : myPrivateFunction2
}

example.js

this.myApi = {
  myFunction: myPrivateFunction,
  myFunction2: myPrivateFunction2
};

@ 将是 window 在文件的主要范围内。

然后通过 window.myApi.myFunction() 从其他地方调用

如果您想将外部函数名称映射到相同的内部名称，如果您不指定 key : value对，默认情况下它只会使用字符串值作为键。

example.coffee

@myApi = {
    myPrivateFunction,
    myPrivateFunction2
}

example.js

this.myApi = {
  myPrivateFunction: myPrivateFunction,
  myPrivateFunction2: myPrivateFunction2
};