WebApi: head()

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

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

構文

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

引数

  • params : object

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

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

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

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

返値: Promise<object>

リクエストの結果です。通常はレスポンスのヘッダ { [header_name: string]: string } が返却されます。

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

例外

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