WebApi: put()

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

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

構文

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

引数

  • params: object

    サーバへ送るリクエストのボディとなるパラメタです。

    この値はリクエストのボディに JSON 形式 (application/json) で記述されます。

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

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

返値: Promise<object>

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

通常、PUT リクエストに対しては 200 OK または 201 Created または 204 No Content に対応する値が返却されます。

  • HTTP 200 OK の場合:

    レスポンスボディに記述された JSON をパースした結果です。

  • HTTP 201 Created の場合:

    { created: true, status: 201 }

  • HTTP 204 No Content の場合:

    { noContent: true, status: 204 }

PUT の結果、サーバ側に新たにリソースが作成された場合には 201 Created が返され、200 OK と 204 No Content はサーバ側の既存のリソースが PUT により変更された場合に返されます。

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

例外

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