【GAS】クラスを作って外部ライブラリとして呼び出したい場合は、ファクトリメソッドを作ろう

はじまり

ここをこう書き換える。

まず、こんな風にclassを使って書かれている処理があるとします。

この書き方だと、Executorオブジェクトを呼べません。

// クラス宣言していた部分
class Executor{
  constructor(){
    this.name = "executor";
  }
  plusOne = function(num){
    let num1 = num + 1;
    return num1;
  }
}

// 別ライブラリからの呼び出し部分
function callExecutor(){
  let tester = Executor(); // ここでエラーになる。
  let num2 = tester.plusOne(3);
  console.log(num2); // 4
}

その処理をこのように、classを使わずにファクトリメソッドを使ってobjectの生成を行います。

// ファクトリメソッド
function createExecutor() {
  return new Executor();
}
// 補完用ダミーメソッド
function plusOne() {
  throw new Error("Call this method after calling createExecutor.");
}
// Executorは補完させないようにする
(function(global){
  function Executor() {
    this.name = "executor";
  }
  Executor.prototype.plusOne = function(num){
    let num1 = num + 1;
    return num1;
  }
}
  global.Executor = Executor;
})(this);

// 別ライブラリからの呼び出し部分
function callExecutor(){
  let tester = createExecutor();
  let num2 = tester.plusOne(3);
  console.log(num2); // 4
}

どうなっているかと言うと・・・

GASでは、別ライブラリからクラスを直接呼び出すことは出来ません。

そのため、createExecutorというクラスをオブジェクト化させる「ファクトリメソッド」というものを作って、そこからクラスから生成したオブジェクトを受け取ります。

// ファクトリメソッド
function createExecutor() {
  return new Executor();
}

しかし、こう書くと困ったことに、ExecutorのメソッドであるplusOneが別のライブラリから入力する時に補完されないのです。

plusOneは、Executorのメソッドであり、かつExecutorは補完されると困るので、function(global)のスコープ内で定義される必要があります。

そのため、plusOneというメソッドを、スコープ外で別の関数として定義して、別ライブラリから使う時に補完させるようにします。

// 補完用ダミーメソッド
function plusOne() {
  throw new Error("Call this method after calling createExecutor.");
}
// Executorは補完させないようにする
(function(global){
  function Executor() {
    this.name = "executor";
  }
  Executor.prototype.plusOne = function(num){
    let num1 = num + 1;
    return num1;
  }
}
  global.Executor = Executor;
})(this);

おしまい

GASのライブラリでクラス化と補完 - Qiita

今回はGASのライブラリでクラス化を補完について書きます。GASでライブラリをクラス化と補完の問題GASのライブラリは補完が有効になるため、開発をラクにする為にも、ライブラリをとりあえず作るシ…

qiita.com

以上になります！