WebApi: get()

HTTP の GET メソッドのリクエストを送ります。

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

構文

webApi.get(params) => Promise<object>

引数

• params: object

  サーバへ送るリクエスト URL のクエリに変換されるパラメタです。

  クエリパラメタの各値は URL エンコードされた JSON 文字列に変換されます。

  path にパターンで指定されたキーワードが含まれる場合、そのキーワードに対応したプロパティが実際のリクエストパスに置換され、残りがクエリパラメタに変換されます。 パターンについては動的なパスの指定を参照してください。

  makeRequest() をオーバライドすることでこの挙動を変更することができます。

返値: Promise<object>

リクエストの結果です。サーバから返されるレスポンスのステータスコードに応じたオブジェクトが返却されます。 返却されるオブジェクトについては HTTP メソッドを参照してください。

通常、GET リクエストに対しては 200 OK 応答のボディが実行結果として返却されます。

makeResponse() をオーバライドすることでこの挙動を変更することができます。

例外

• WebApiError
  • HTTP 4xx / 5xx 系の応答が返却された場合。