registerDefaultConnector()

アプリケーション開発者が独自に定義した DBConnector の派生クラスを、getDefaultConnector() から使えるようにします。

構文

registerDefaultConnector(databaseType, modulePath) => void

引数

• databaseType: string

  データベース種別です。

  登録される DBConnector の派生クラスを識別するために使います。

  引数 databaseType の値に対してモジュールパスが既に登録されている場合、この関数は何も行いません。

• modulePath: string

  登録される DBConnector の派生クラスが定義されたモジュールファイルのパスです。

  モジュールファイルの記述方法については#解説を参照してください。

解説

アプリケーション開発者が独自に定義した DBConnector の派生クラスを、getDefaultConnector() から使えるようにします。

引数 databaseType の値に対してモジュールパスが既に登録されている場合、この関数は何も行いません。

登録されたモジュールファイルは関数 getDefaultConnector() の呼び出しに際し読み込まれます。 この際、モジュールはそのデフォルトエクスポートとして DBConnector の派生クラスを設定していなければなりません。

//  CommonJS

class SomeDBConnector extends DBConnector {
    /* 特定のデータベース向けの DBConnector の実装 */
}

//  デフォルトエクスポート
module.exports = SomeDBConnector;

//  ESM

class SomeDBConnector extends DBConnector {
    /* 特定のデータベース向けの DBConnector の実装 */
}

//  デフォルトエクスポート
export default SomeDBConnector;