JavaScriptのAjax処理の共通化において、コールバック関数に何もしない動作を指定する

Question

Ajaxの処理を同じ画面で何度も行うため共通化したいと考え、
関数connectAjaxの引数にAjaxで必要な情報を入れる形の実装をしています。

引数には
type,
actionPath,
param,
beforeSendCallBack ,
_this,
successCallBack,
errorCallBack
の6つを指定しました。

function connectAjax(type,actionPath, param, beforeSendCallBack ,_this, successCallBack, errorCallBack) {
    //* ajax
    console.log(beforeSendCallBack);
    $.ajax({
        type: type,
        headers: {
            'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
        },
        dataType: 'json',
        url: 'http://'+location.host+actionPath,
        data: param,
        beforeSend:beforeSendCallBack(_this)
    }).done(function (data, textStatus, xhr) {
        if (data.status == 200) {
            return successCallBack(data , _this);
        } else {
            return errorCallBack(data , _this);
        }
    }).fail(function(xhr, stat, e){
        //*  error 
        //console.log(xhr);
        return 'fail error';

    }).always(function(data){
        // --
    });
}

第4引数のbeforeSendCallBack の部分は、 beforeSendに何も処理が必要無い場合、nullを入れると、
Uncaught TypeError: beforeSendCallBack is not a function
が表示されています。

この場合、何を入れるのが適切でしょうか。（何もしない関数のようなものを指定したいです）
それとも、書き方がそもそも違っているのでしょうか？

データの型のようなものが違っているのではと考え、
「JavaScript 関数の引数に関数」
などと検索してるのですが、関数の引数の書き方がヒットしてしまい期待通りの結果が得られていません。。

お知恵をお借りできますと幸いです。
よろしくお願い致します。

Answer 1

function test( fn ) {
  fn();
}
test( function(){} );

Answer 2

なんとも言えませんが、普通はapi側で吸収する話では？

Comments

[AkitoshiManabe]

同感です。私の回答も、jQuery 周辺の話題を避け、ライブラリ開発のよくある話として纏めました。

Answer 3

ご質問の connectAjax() のように引数でコールバック関数を受け取る関数は、その処理中に実行箇所があるはずですので、引数が与えられなかったり関数以外であった場合の対策が必要です。

---

１）コールバック関数(cb1, cb2)が関数であることを確認する

ユーザにAPI開放するような例では、関数オブジェクト以外を渡される事例もあるのでチェック

function anyMethod( arg1, arg2, cb1, cb2 ) {

  // 必須の場合
  if("function"!==typeof cb1) {
    throw TypeError( `anyMethod required "function" in 3rd argument.` );
  }
  cb1();

  // 省略できる場合
  "function"===typeof cb2 && cb2();
}

２）NOOP(何もしない関数) を利用できる例
引数に関数を与える/与えないのどちらかしかない、非公開の場合

var noop = function(){};

function anyMethod( arg1, arg2, cb1, cb2 ) {
  cb1 || (cb1=noop);
  cb2 || (cb2=noop);
  /* write here, your process */
}

function anyMethod2( arg1, arg2, cb1=noop, cb2=noop ) {
  /* write here, your process */
}

Comments

[yahret45]

ありがとうございます！大変参考になりました。