error
整数 (オプション) - 値が設定されている場合、request
はerror
番号で失敗します。使用可能なエラー番号については、net エラー一覧を参照してください。
statusCode
数値 (オプション) - HTTPレスポンスコード、デフォルトは200。
charset
文字列 (オプション) - レスポンスボディの文字セット、デフォルトは"utf-8"
。
mimeType
文字列 (オプション) - レスポンスボディのMIMEタイプ、デフォルトは"text/html"
。mimeType
を設定すると、レスポンスのcontent-type
ヘッダーが暗黙的に設定されますが、headers
にcontent-type
が既に設定されている場合、mimeType
は無視されます。
headers
Record<string, string | string[]> (オプション) - レスポンスヘッダーを含むオブジェクト。キーは文字列でなければならず、値は文字列または文字列の配列でなければなりません。
data
(Buffer | 文字列 | ReadableStream) (オプション) - レスポンスボディ。ストリームをレスポンスとして返す場合、これはレスポンスボディを表すNode.jsの読み取り専用ストリームです。Buffer
をレスポンスとして返す場合、これはBuffer
です。string
をレスポンスとして返す場合、これはstring
です。他のタイプのレスポンスでは無視されます。
path
文字列 (オプション) - レスポンスボディとして送信されるファイルへのパス。ファイルレスポンスの場合のみ使用されます。
url
文字列 (オプション) - url
をダウンロードし、結果をレスポンスボディとしてパイプします。URLレスポンスの場合のみ使用されます。
referrer
文字列 (オプション) - referrer
URL。ファイルレスポンスとURLレスポンスの場合のみ使用されます。
method
文字列 (オプション) - HTTP method
。ファイルレスポンスとURLレスポンスの場合のみ使用されます。
session
Session (オプション) - URLを要求するために使用されるセッション。デフォルトでは、HTTPリクエストは現在のセッションを再利用します。session
をnull
に設定すると、ランダムな独立したセッションが使用されます。URLレスポンスの場合のみ使用されます。
uploadData
ProtocolResponseUploadData (オプション) - アップロードデータとして使用されるデータ。method
が"POST"
であるURLレスポンスの場合のみ使用されます。