次の方法で共有


WebResourceLike interface

REST 呼び出しの抽象化。

プロパティ

abortSignal

後で要求を中止するために使用されます。

agentSettings

HTTP(S) エージェントの構成。

body

要求の HTTP 本文の内容。

formData
headers

要求を行うときに使用する HTTP ヘッダー。

keepAlive

接続を再利用する必要がある場合。

method

要求を行うときに使用する HTTP メソッド。

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onUploadProgress

アップロードの進行状況時に発生するコールバック。

operationResponseGetter

指定した OperationSpec と HttpOperationResponse の組み合わせに対して適切な OperationResponse を返す関数。 これが未定義の場合は、単純な状態コード参照が使用されます。

operationSpec

応答を解析するために使用されます。

proxySettings

プロキシの構成。

query

オブジェクトとして表されるクエリ文字列。

redirectLimit

この要求に対して従うリダイレクトの数を制限します。 0 に設定すると、リダイレクトは実行されません。 未定義のままにすると、基になるnode_fetchの既定のリダイレクト動作が適用されます。

shouldDeserialize

HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。

streamResponseBody

HttpOperationResponse の本文をストリームとして扱う必要があるかどうか。

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。

url

要求によってアクセスされる URL。

withCredentials

XHR 中に資格情報 (Cookie) を送信する必要がある場合。

メソッド

clone()

この要求オブジェクトを複製します。

prepare(RequestPrepareOptions)

要求のオプションを設定します。

validateRequestProperties()

メソッド、url、headers["Content-Type"]、headers["accept-language"] などの必須プロパティが定義されていることを検証します。 上記のプロパティのいずれかが定義されていない場合は、エラーがスローされます。

プロパティの詳細

abortSignal

後で要求を中止するために使用されます。

abortSignal?: AbortSignalLike

プロパティ値

agentSettings

HTTP(S) エージェントの構成。

agentSettings?: AgentSettings

プロパティ値

body

要求の HTTP 本文の内容。

body?: any

プロパティ値

any

formData

formData?: any

プロパティ値

any

headers

要求を行うときに使用する HTTP ヘッダー。

headers: HttpHeadersLike

プロパティ値

keepAlive

接続を再利用する必要がある場合。

keepAlive?: boolean

プロパティ値

boolean

method

要求を行うときに使用する HTTP メソッド。

method: HttpMethods

プロパティ値

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

operationResponseGetter

指定した OperationSpec と HttpOperationResponse の組み合わせに対して適切な OperationResponse を返す関数。 これが未定義の場合は、単純な状態コード参照が使用されます。

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

プロパティ値

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

応答を解析するために使用されます。

operationSpec?: OperationSpec

プロパティ値

proxySettings

プロキシの構成。

proxySettings?: ProxySettings

プロパティ値

query

オブジェクトとして表されるクエリ文字列。

query?: {[key: string]: any}

プロパティ値

{[key: string]: any}

redirectLimit

この要求に対して従うリダイレクトの数を制限します。 0 に設定すると、リダイレクトは実行されません。 未定義のままにすると、基になるnode_fetchの既定のリダイレクト動作が適用されます。

redirectLimit?: number

プロパティ値

number

shouldDeserialize

HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

プロパティ値

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

HttpOperationResponse の本文をストリームとして扱う必要があるかどうか。

streamResponseBody?: boolean

プロパティ値

boolean

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。

timeout: number

プロパティ値

number

url

要求によってアクセスされる URL。

url: string

プロパティ値

string

withCredentials

XHR 中に資格情報 (Cookie) を送信する必要がある場合。

withCredentials: boolean

プロパティ値

boolean

メソッドの詳細

clone()

この要求オブジェクトを複製します。

function clone(): WebResourceLike

戻り値

prepare(RequestPrepareOptions)

要求のオプションを設定します。

function prepare(options: RequestPrepareOptions): WebResourceLike

パラメーター

戻り値

validateRequestProperties()

メソッド、url、headers["Content-Type"]、headers["accept-language"] などの必須プロパティが定義されていることを検証します。 上記のプロパティのいずれかが定義されていない場合は、エラーがスローされます。

function validateRequestProperties()