AlierDB: connect()

データベースへ接続します。

この関数は非同期関数です。

構文

alierDb.connect() => Promise<object>

返値: Promise<object>

データベース接続の実行結果を表すオブジェクトを与える Promise です。

成功時には、結果のオブジェクトは以下のプロパティを持ちます:

  • status: true

    成功したかどうかを表す boolean です。常に true を取ります。

失敗時には、結果のオブジェクトは以下のプロパティを持ちます:

  • status: false

    成功したかどうかを表す boolean です。常に false を取ります。

  • message: string | undefined

    エラーメッセージです。エラーの詳細が分かっている場合にのみ定義されます。

解説

データベースへ接続します。

実装は DBConnector.connect() に依存します。