RouteGetRouteRangeOptionalParams interface
省略可能なパラメーター。
- Extends
-
RequestOptionsBase
プロパティ
acceleration |
車両が加速したときに燃料に格納されている化学エネルギーを運動エネルギーに変換する効率を指定します (例: KineticEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed は、 fuelEnergyDensityInMJoulesPerLiter を使用して、消費された燃料を化学エネルギーに変換することによって得られます。 減速効率と組み合わせて使用 する必要があります。 使用できる値の範囲は、0.0 から 1/減速効率です。 良識値 : 燃焼モデル の場合 : 0.33, 電気モデル : 0.66 |
auxiliary |
補助システムを維持するために消費される電力の量をキロワット (kW) 単位で指定します。 ACシステム、無線、暖房などのデバイスやシステムによる消費を指定するために使用できます。 賢明な値: 1.7 |
auxiliary |
車両の補助システムを維持するために消費される燃料の量を 1 時間あたりのリットル単位で指定します。 ACシステム、無線、暖房などのデバイスやシステムによる消費を指定するために使用できます。 賢明な値: 0.2 |
avoid | ルートの決定時にルート計算で回避する必要のあるものを指定します。 "&avoid=motorways&avoid=tollRoads&avoid=ferrys" など、1 つの要求で複数回指定できます。 calculateReachableRange 要求では、既にUsedRoads の値を使用しないでください。 指定できる値は、'tollRoads'、'高速道路'、'ferrys'、'unpavedRoads'、'carpools'、'alreadyUsedRoads'、'borderCrossings' です。 |
constant |
消費の速度に依存するコンポーネントを指定します。 速度と消費レートのペアの順序なしのリストとして提供されます。 この一覧では、消費曲線上のポイントを定義します。 一覧にない速度の従量課金レートは次のとおりです。
リストには 1 ~ 25 ポイント (両端を含む) が含まれている必要があり、同じ速度の重複するポイントが含まれていない可能性があります。 1 つのポイントのみが含まれている場合は、そのポイントの消費率がそれ以上処理されずに使用されます。 最大速度に対して指定される消費量は、最後の最大速度以上である必要があります。 これにより、外挿によって消費率がマイナスにならないことが保証されます。 同様に、一覧の 2 つの最小速度に対して指定された従量課金の値は、速度が小さい場合に負の消費率を招くことはできません。 消費値 (kWh/100km で表される) の有効な範囲は、0.01 から 100000.0 の間です。 賢明な値: 50,8.2:130,21.3 このパラメーターは、 電力消費モデルに必要です。 |
constant |
消費の速度に依存するコンポーネントを指定します。 コロンで区切られた速度 & 従量課金制ペアの順序なしのリストとして提供されます。 この一覧では、消費曲線上のポイントを定義します。 一覧にない速度の従量課金レートは次のとおりです。
リストには 1 ~ 25 ポイント (両端を含む) が含まれている必要があり、同じ速度の重複するポイントが含まれていない可能性があります。 1 つのポイントのみが含まれている場合は、そのポイントの消費率がそれ以上処理されずに使用されます。 最大速度に対して指定される消費量は、最後の最大速度以上である必要があります。 これにより、外挿によって消費率がマイナスにならないことが保証されます。 同様に、一覧の 2 つの最小速度に対して指定された従量課金の値は、速度が小さい場合に負の消費率を招くことはできません。 従量課金値 (l/100km で表される) の有効な範囲は、0.01 から 100000.0 の間です。 賢明な値: 50,6.3:130,11.5 注 : このパラメーターは 、燃焼消費モデルに必要です。 |
current |
現在の電力供給量をキロワット時 (kWh) 単位で指定します。 このパラメーターは maxChargeInkWh パラメーターと共に存在します。 使用できる値の範囲は、0.0 ~ maxChargeInkWh です。 賢明な値: 43 |
current |
燃料の現在の供給量をリットル単位で指定します。 賢明な値: 55 |
deceleration |
車両が減速した場合 (つまり、ChemicalEnergySaved/KineticEnergyLost)、運動エネルギーを節約 (消費されない) 燃料に変換する効率を指定します。ChemicalEnergySaved は、 fuelEnergyDensityInMJoulesPerLiter を使用して、保存された (消費されていない) 燃料をエネルギーに変換することによって取得されます。 accelerationEfficiency とペアにする必要があります。 使用できる値の範囲は、0.0 ~ 1/accelerationEfficiency です。 良識値: 燃焼モデル の場合: 0.83、 電気モデル の場合: 0.91 |
depart |
出発地点からの出発日時。 現在とは別の出発時刻は、dateTime として指定する必要があります。 タイム ゾーン オフセットが指定されていない場合は、原点のオフセットと見なされます。 departAt 値は、将来の日付/時刻形式 (1996-12-19T16:39:57-08:00) である必要があります。 |
downhill |
車両が標高を失ったとき (つまり、ChemicalEnergySaved/PotentialEnergyLost) に対して、潜在的なエネルギーを節約 (消費されていない) 燃料に変換する効率を指定します。ChemicalEnergySaved は、 fuelEnergyDensityInMJoulesPerLiter を使用して、保存された (消費されていない) 燃料をエネルギーに変換することによって取得されます。 uphillEfficiency とペアにする必要があります。 使用できる値の範囲は 0.0 ~ 1/uphillEfficiency です。 良識値 : 燃焼モデル の場合 : 0.51, 電気モデル : 0.73 |
energy |
指定された電力消費モデルを使用して移動できる最大範囲を決定するキロワット時間 (kWh) の電気エネルギー予算。 vehicleEngineType が Electric で timeBudgetInSec が使用されていない場合は、このパラメーターが必要です。 fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec のいずれかを指定する必要があります。 |
fuel |
指定された燃焼消費モデルを使用して走行できる最大の範囲を決定するリットル単位の燃料予算。 vehicleEngineType が Combustion で timeBudgetInSec が使用されていない場合は、このパラメーターが必要です。 fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec のいずれかを指定する必要があります。 |
fuel |
メガジュール (MJ) 内の 1 リットルの燃料に格納される化学エネルギーの量を指定します。 これは、保存または消費されたエネルギーと燃料の間の変換のために*効率 パラメータと組み合わせて使用されます。 たとえば、エネルギー密度はガソリンの場合は 34.2 MJ/l、ディーゼル燃料の場合は 35.8 MJ/l です。 *Efficiency パラメーターが設定されている場合は、このパラメーターが必要です。 賢明な値: 34.2 |
hilliness | スリリングなルートのためのヒルネスの程度。 このパラメーターは、=thrilling と |
max |
車両のバッテリーに格納できる最大電力供給量をキロワット時 (kWh) 単位で指定します。 このパラメーターは currentChargeInkWh パラメーターと共に存在します。 最小値は currentChargeInkWh 以上である必要があります。 賢明な値: 85 |
route |
要求されたルートの種類。 可能な値は次のとおりです。'最速'、'最短'、'eco'、'スリル' |
time |
運転時間を使用して移動できる最大の範囲を決定する時間の予算 (秒単位)。 従量課金パラメーターはエコルートにのみ影響し、それによって間接的に運転時間に影響します。 fuelBudgetInLiters または energyBudgetInkWh が使用されていない場合は、このパラメーターが必要です。 fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec のいずれかを指定する必要があります。 |
traffic | 指定できる値
|
travel |
要求されたルートの移動モード。 要求された travelMode がルート全体で使用できない場合があることに注意してください。 要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は他の要素になります。 移動モードバス、オートバイ、タクシー、バンはベータ機能であることに注意してください。 すべての領域で完全な制限データを使用できるわけではありません。 CalculateReachableRange 要求では、自転車と歩行者の値を使用しないでください。 使用可能な値は、'car'、'truck'、'taxi'、'bus'、'van'、'motorcycle'、'bicycle'、'pedestrian' です。 |
uphill |
車両が昇格したときに、燃料に格納されている化学エネルギーを潜在的なエネルギーに変換する効率を指定します (つまり、PotentialEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed は、 fuelEnergyDensityInMJoulesPerLiter を使用して、消費された燃料を化学エネルギーに変換することによって得られます。 ダウンヒル効率性と組み合わせて使用する必要があります。 使用できる値の範囲は 0.0 ~ 1/分の 1 です。非効率性です。 良識値 : 燃焼モデル の場合 : 0.27, 電気モデル : 0.74 |
vehicle |
車両の車軸あたりの重量 (kg)。 値が 0 の場合、車軸あたりの重量制限は考慮されません。 |
vehicle |
車両は商用目的で使用されるため、一部の道路では運転できない場合があります。 |
vehicle |
車両のエンジンタイプ。 詳細な従量課金モデルを指定する場合は、 vehicleEngineType の値と一致している必要があります。 使用可能な値は次のとおりです: '燃焼'、'電気' |
vehicle |
車両の高さ (メートル単位)。 値が 0 の場合、高さの制限は考慮されません。 |
vehicle |
車両の長さ (メートル単位)。 値が 0 の場合、長さの制限は考慮されません。 |
vehicle |
危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、US Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、otherHazmat は他のすべての国で使用する必要があります。 vehicleLoadType は複数回指定できます。 このパラメーターは現在、travelMode=truck でのみ考慮されています。 使用可能な値は、'USHazmatClass1' です。 'USHazmatClass2'、'USHazmatClass3'、'USHazmatClass4'、'USHazmatClass5'、'USHazmatClass6'、'USHazmatClass7'、'USHazmatClass8'、'USHazmatClass9'、'otherHazmatExplosive'、'otherHazmatGeneral'、'otherHazmatHarmfulToWater' |
vehicle |
km/時間の車両の最高速度。 値 0 は、車両の適切な値が決定され、ルート計画中に適用されることを意味します。 0 以外の値は、ルート計画中にオーバーライドされる可能性があります。 |
vehicle |
車両の重量 (kg 単位)。
賢明な値 : 燃焼モデル の場合 : 1600, 電気モデル : 1900 |
vehicle |
車両の幅 (メートル単位)。 値が 0 の場合、幅の制限は考慮されません。 |
windingness | スリリングなルートのためのターンのレベル。 このパラメーターは、routeType=thrilling と組み合わせてのみ使用できます。 指定できる値は、'low'、'normal'、'high' です。 |
継承されたプロパティ
abort |
要求を中止するために使用できるシグナル。 |
custom |
{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。 |
on |
ダウンロードの進行状況時に発生するコールバック。 |
on |
アップロードの進行状況時に発生するコールバック。 |
timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。 |
プロパティの詳細
accelerationEfficiency
車両が加速したときに燃料に格納されている化学エネルギーを運動エネルギーに変換する効率を指定します (例: KineticEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed は、 fuelEnergyDensityInMJoulesPerLiter を使用して、消費された燃料を化学エネルギーに変換することによって得られます。 減速効率と組み合わせて使用 する必要があります。
使用できる値の範囲は、0.0 から 1/減速効率です。
良識値 : 燃焼モデル の場合 : 0.33, 電気モデル : 0.66
accelerationEfficiency?: number
プロパティ値
number
auxiliaryPowerInkW
補助システムを維持するために消費される電力の量をキロワット (kW) 単位で指定します。 ACシステム、無線、暖房などのデバイスやシステムによる消費を指定するために使用できます。
賢明な値: 1.7
auxiliaryPowerInkW?: string
プロパティ値
string
auxiliaryPowerInLitersPerHour
車両の補助システムを維持するために消費される燃料の量を 1 時間あたりのリットル単位で指定します。 ACシステム、無線、暖房などのデバイスやシステムによる消費を指定するために使用できます。
賢明な値: 0.2
auxiliaryPowerInLitersPerHour?: number
プロパティ値
number
avoid
ルートの決定時にルート計算で回避する必要のあるものを指定します。 "&avoid=motorways&avoid=tollRoads&avoid=ferrys" など、1 つの要求で複数回指定できます。 calculateReachableRange 要求では、既にUsedRoads の値を使用しないでください。 指定できる値は、'tollRoads'、'高速道路'、'ferrys'、'unpavedRoads'、'carpools'、'alreadyUsedRoads'、'borderCrossings' です。
avoid?: Avoid[]
プロパティ値
Avoid[]
constantSpeedConsumptionInkWhPerHundredkm
消費の速度に依存するコンポーネントを指定します。 速度と消費レートのペアの順序なしのリストとして提供されます。 この一覧では、消費曲線上のポイントを定義します。 一覧にない速度の従量課金レートは次のとおりです。
線形補間によって、指定された速度がリスト内の 2 つの速度の間にある場合
それ以外の場合は線形外挿によって、リスト内の最も近い 2 つのポイントによって決定される定数 (ΔConsumption/ΔSpeed) を想定します
リストには 1 ~ 25 ポイント (両端を含む) が含まれている必要があり、同じ速度の重複するポイントが含まれていない可能性があります。 1 つのポイントのみが含まれている場合は、そのポイントの消費率がそれ以上処理されずに使用されます。
最大速度に対して指定される消費量は、最後の最大速度以上である必要があります。 これにより、外挿によって消費率がマイナスにならないことが保証されます。
同様に、一覧の 2 つの最小速度に対して指定された従量課金の値は、速度が小さい場合に負の消費率を招くことはできません。
消費値 (kWh/100km で表される) の有効な範囲は、0.01 から 100000.0 の間です。
賢明な値: 50,8.2:130,21.3
このパラメーターは、 電力消費モデルに必要です。
constantSpeedConsumptionInkWhPerHundredkm?: string
プロパティ値
string
constantSpeedConsumptionInLitersPerHundredkm
消費の速度に依存するコンポーネントを指定します。 コロンで区切られた速度 & 従量課金制ペアの順序なしのリストとして提供されます。 この一覧では、消費曲線上のポイントを定義します。 一覧にない速度の従量課金レートは次のとおりです。
線形補間によって、指定された速度がリスト内の 2 つの速度の間にある場合
それ以外の場合は線形外挿によって、リスト内の最も近い 2 つのポイントによって決定される定数 (ΔConsumption/ΔSpeed) を想定します
リストには 1 ~ 25 ポイント (両端を含む) が含まれている必要があり、同じ速度の重複するポイントが含まれていない可能性があります。 1 つのポイントのみが含まれている場合は、そのポイントの消費率がそれ以上処理されずに使用されます。
最大速度に対して指定される消費量は、最後の最大速度以上である必要があります。 これにより、外挿によって消費率がマイナスにならないことが保証されます。
同様に、一覧の 2 つの最小速度に対して指定された従量課金の値は、速度が小さい場合に負の消費率を招くことはできません。
従量課金値 (l/100km で表される) の有効な範囲は、0.01 から 100000.0 の間です。
賢明な値: 50,6.3:130,11.5
注 : このパラメーターは 、燃焼消費モデルに必要です。
constantSpeedConsumptionInLitersPerHundredkm?: number
プロパティ値
number
currentChargeInkWh
現在の電力供給量をキロワット時 (kWh) 単位で指定します。 このパラメーターは maxChargeInkWh パラメーターと共に存在します。
使用できる値の範囲は、0.0 ~ maxChargeInkWh です。
賢明な値: 43
currentChargeInkWh?: string
プロパティ値
string
currentFuelInLiters
燃料の現在の供給量をリットル単位で指定します。 賢明な値: 55
currentFuelInLiters?: number
プロパティ値
number
decelerationEfficiency
車両が減速した場合 (つまり、ChemicalEnergySaved/KineticEnergyLost)、運動エネルギーを節約 (消費されない) 燃料に変換する効率を指定します。ChemicalEnergySaved は、 fuelEnergyDensityInMJoulesPerLiter を使用して、保存された (消費されていない) 燃料をエネルギーに変換することによって取得されます。 accelerationEfficiency とペアにする必要があります。
使用できる値の範囲は、0.0 ~ 1/accelerationEfficiency です。
良識値: 燃焼モデル の場合: 0.83、 電気モデル の場合: 0.91
decelerationEfficiency?: number
プロパティ値
number
departAt
出発地点からの出発日時。 現在とは別の出発時刻は、dateTime として指定する必要があります。 タイム ゾーン オフセットが指定されていない場合は、原点のオフセットと見なされます。 departAt 値は、将来の日付/時刻形式 (1996-12-19T16:39:57-08:00) である必要があります。
departAt?: Date
プロパティ値
Date
downhillEfficiency
車両が標高を失ったとき (つまり、ChemicalEnergySaved/PotentialEnergyLost) に対して、潜在的なエネルギーを節約 (消費されていない) 燃料に変換する効率を指定します。ChemicalEnergySaved は、 fuelEnergyDensityInMJoulesPerLiter を使用して、保存された (消費されていない) 燃料をエネルギーに変換することによって取得されます。 uphillEfficiency とペアにする必要があります。
使用できる値の範囲は 0.0 ~ 1/uphillEfficiency です。
良識値 : 燃焼モデル の場合 : 0.51, 電気モデル : 0.73
downhillEfficiency?: number
プロパティ値
number
energyBudgetInkWh
指定された電力消費モデルを使用して移動できる最大範囲を決定するキロワット時間 (kWh) の電気エネルギー予算。 vehicleEngineType が Electric で timeBudgetInSec が使用されていない場合は、このパラメーターが必要です。 fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec のいずれかを指定する必要があります。
energyBudgetInkWh?: number
プロパティ値
number
fuelBudgetInLiters
指定された燃焼消費モデルを使用して走行できる最大の範囲を決定するリットル単位の燃料予算。 vehicleEngineType が Combustion で timeBudgetInSec が使用されていない場合は、このパラメーターが必要です。 fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec のいずれかを指定する必要があります。
fuelBudgetInLiters?: number
プロパティ値
number
fuelEnergyDensityInMJoulesPerLiter
メガジュール (MJ) 内の 1 リットルの燃料に格納される化学エネルギーの量を指定します。 これは、保存または消費されたエネルギーと燃料の間の変換のために*効率 パラメータと組み合わせて使用されます。 たとえば、エネルギー密度はガソリンの場合は 34.2 MJ/l、ディーゼル燃料の場合は 35.8 MJ/l です。 *Efficiency パラメーターが設定されている場合は、このパラメーターが必要です。
賢明な値: 34.2
fuelEnergyDensityInMJoulesPerLiter?: number
プロパティ値
number
hilliness
スリリングなルートのためのヒルネスの程度。 このパラメーターは、=thrilling と routeType
組み合わせてのみ使用できます。 指定できる値は、'low'、'normal'、'high' です。
hilliness?: Hilliness
プロパティ値
maxChargeInkWh
車両のバッテリーに格納できる最大電力供給量をキロワット時 (kWh) 単位で指定します。 このパラメーターは currentChargeInkWh パラメーターと共に存在します。
最小値は currentChargeInkWh 以上である必要があります。
賢明な値: 85
maxChargeInkWh?: string
プロパティ値
string
routeType
timeBudgetInSec
運転時間を使用して移動できる最大の範囲を決定する時間の予算 (秒単位)。 従量課金パラメーターはエコルートにのみ影響し、それによって間接的に運転時間に影響します。 fuelBudgetInLiters または energyBudgetInkWh が使用されていない場合は、このパラメーターが必要です。 fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec のいずれかを指定する必要があります。
timeBudgetInSec?: number
プロパティ値
number
traffic
指定できる値
- true - ルーティング中に使用可能なすべてのトラフィック情報を考慮してください
- false - ルーティング中に現在のトラフィック データを無視します。 現在のトラフィック データはルーティング中は無視されますが、有効な道路速度に対する履歴トラフィックの影響は引き続き組み込まれます。
traffic?: boolean
プロパティ値
boolean
travelMode
要求されたルートの移動モード。 要求された travelMode がルート全体で使用できない場合があることに注意してください。 要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は他の要素になります。 移動モードバス、オートバイ、タクシー、バンはベータ機能であることに注意してください。 すべての領域で完全な制限データを使用できるわけではありません。 CalculateReachableRange 要求では、自転車と歩行者の値を使用しないでください。 使用可能な値は、'car'、'truck'、'taxi'、'bus'、'van'、'motorcycle'、'bicycle'、'pedestrian' です。
travelMode?: TravelMode
プロパティ値
uphillEfficiency
車両が昇格したときに、燃料に格納されている化学エネルギーを潜在的なエネルギーに変換する効率を指定します (つまり、PotentialEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed は、 fuelEnergyDensityInMJoulesPerLiter を使用して、消費された燃料を化学エネルギーに変換することによって得られます。 ダウンヒル効率性と組み合わせて使用する必要があります。
使用できる値の範囲は 0.0 ~ 1/分の 1 です。非効率性です。
良識値 : 燃焼モデル の場合 : 0.27, 電気モデル : 0.74
uphillEfficiency?: number
プロパティ値
number
vehicleAxleWeight
車両の車軸あたりの重量 (kg)。 値が 0 の場合、車軸あたりの重量制限は考慮されません。
vehicleAxleWeight?: number
プロパティ値
number
vehicleCommercial
車両は商用目的で使用されるため、一部の道路では運転できない場合があります。
vehicleCommercial?: boolean
プロパティ値
boolean
vehicleEngineType
車両のエンジンタイプ。 詳細な従量課金モデルを指定する場合は、 vehicleEngineType の値と一致している必要があります。 使用可能な値は次のとおりです: '燃焼'、'電気'
vehicleEngineType?: VehicleEngineType
プロパティ値
vehicleHeight
車両の高さ (メートル単位)。 値が 0 の場合、高さの制限は考慮されません。
vehicleHeight?: number
プロパティ値
number
vehicleLength
車両の長さ (メートル単位)。 値が 0 の場合、長さの制限は考慮されません。
vehicleLength?: number
プロパティ値
number
vehicleLoadType
危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、US Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、otherHazmat は他のすべての国で使用する必要があります。 vehicleLoadType は複数回指定できます。 このパラメーターは現在、travelMode=truck でのみ考慮されています。 使用可能な値は、'USHazmatClass1' です。 'USHazmatClass2'、'USHazmatClass3'、'USHazmatClass4'、'USHazmatClass5'、'USHazmatClass6'、'USHazmatClass7'、'USHazmatClass8'、'USHazmatClass9'、'otherHazmatExplosive'、'otherHazmatGeneral'、'otherHazmatHarmfulToWater'
vehicleLoadType?: VehicleLoadType
プロパティ値
vehicleMaxSpeed
km/時間の車両の最高速度。 値 0 は、車両の適切な値が決定され、ルート計画中に適用されることを意味します。 0 以外の値は、ルート計画中にオーバーライドされる可能性があります。
vehicleMaxSpeed?: number
プロパティ値
number
vehicleWeight
車両の重量 (kg 単位)。
*効率パラメーターのいずれかが設定されている場合は必須です。
従量課金モデルのコンテキストで使用する場合は、厳密に正である必要があります。 重みの制限が考慮されます。
詳細な 従量課金モデル が指定されておらず、 vehicleWeight の値が 0 以外の場合は、重量制限が考慮されます。
それ以外の場合は、このパラメーターは無視されます。
賢明な値 : 燃焼モデル の場合 : 1600, 電気モデル : 1900
vehicleWeight?: number
プロパティ値
number
vehicleWidth
車両の幅 (メートル単位)。 値が 0 の場合、幅の制限は考慮されません。
vehicleWidth?: number
プロパティ値
number
windingness
スリリングなルートのためのターンのレベル。 このパラメーターは、routeType=thrilling と組み合わせてのみ使用できます。 指定できる値は、'low'、'normal'、'high' です。
windingness?: Windingness
プロパティ値
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
AbortSignalLike
継承元 RequestOptionsBase.abortSignal
customHeaders
{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
customHeaders?: [key: string]: string
プロパティ値
[key: string]: string
継承元 RequestOptionsBase.customHeaders
onDownloadProgress
ダウンロードの進行状況時に発生するコールバック。
onDownloadProgress?: (progress: TransferProgressEvent) => void
プロパティ値
(progress: TransferProgressEvent) => void
継承元 RequestOptionsBase.onDownloadProgress
onUploadProgress
アップロードの進行状況時に発生するコールバック。
onUploadProgress?: (progress: TransferProgressEvent) => void
プロパティ値
(progress: TransferProgressEvent) => void
継承元 RequestOptionsBase.onUploadProgress
timeout
要求が自動的に終了するまでの時間 (ミリ秒)。
timeout?: number
プロパティ値
number
継承元 RequestOptionsBase.timeout