WebApi: patch()

HTTP の PATCH メソッドの要求に対する処理を実装します。

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

構文

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

引数

• params: object

  クライアントから送られてきたリクエストのパラメタです。これらは URL に含まれるクエリパラメタとリクエストのボディから取得されます。

  [path][path] が変数ラベルを含む場合、クライアントから送信されたリクエストのパスから、変数ラベルに対応する単語がパラメタとして取り出される。詳しくは get() を参照してください。

返値: Promise<object>

リクエストを処理した結果です。この値はレスポンスのボディに書き込まれます。

ただしオブジェクトにプロパティ statusCode が指定されている場合、これはレスポンスのステータスコードの値に使用されます。

もし statusCode が 200 から 599 までの整数値でなければその値は無視されます。

また statusCode に 204 を設定した場合、レスポンスにボディが設定されないため、他のプロパティの値は無視されます。

例外

• MethodNotAllowedError
  • 基底クラスの実装が呼び出された際。

解説

既定の実装では MethodNotAllowedError を発生させます。

PATCH HTTP メソッドを使用する場合は派生クラスのメソッドとしてオーバライドする必要がある。