PipelineRequest interface
بيانات التعريف حول طلب يتم إجراؤه بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية.
الخصائص
| abort |
يستخدم لإجهاض الطلب لاحقا. |
| agent | NODEJS فقط خيار عقدة فقط لتوفير |
| allow |
تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS |
| body | محتوى نص HTTP (إن وجد) |
| disable |
إذا كان لا ينبغي إعادة استخدام الاتصال. |
| enable |
المستعرض فقط خيار مستعرض فقط لتمكين تدفقات المستعرض. إذا تم تعيين هذا الخيار وكانت الاستجابة عبارة عن دفق، فسيكون للاستجابة خاصية القيمة الافتراضية خاطئة |
| form |
لمحاكاة منشور نموذج مستعرض |
| headers | عناوين HTTP لاستخدامها عند إجراء الطلب. |
| method | أسلوب HTTP المراد استخدامه عند إجراء الطلب. |
| multipart |
نص طلب متعدد الأحزاب. |
| on |
رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل. |
| on |
رد الاتصال الذي يتم إطلاقه عند تقدم التحميل. |
| proxy |
تكوين الوكيل. |
| request |
معرف فريد للطلب. يستخدم للتسجيل والتتبع. |
| request |
خيارات إضافية لتعيينها عند الطلب. يوفر هذا طريقة لتجاوز الخصائص الموجودة أو توفير خصائص الطلب التي لم يتم الإعلان عنها. للتعرف على الخصائص الصالحة المحتملة، راجع
تحذير: ستقوم الخيارات المحددة هنا بتجاوز أي خصائص تحمل نفس الأسماء عند إرسال الطلب بواسطة HttpClient. |
| stream |
قائمة رموز حالة الاستجابة التي يجب التعامل مع نص PipelineResponse المقابل لها كتدفق. عندما تحتوي streamResponseStatusCodes على القيمة Number.POSITIVE_INFINITY سيتم التعامل مع أي حالة على أنها دفق. |
| timeout | عدد المللي ثانية التي يمكن أن يستغرقها الطلب قبل إنهائه تلقائيا.
إذا تم إنهاء الطلب، يتم طرح |
| tls |
إعدادات تكوين مصادقة TLS |
| tracing |
خيارات التتبع لاستخدامها لأي امتدادات تم إنشاؤها. |
| url | عنوان URL لتقديم الطلب إليه. |
| with |
يشير إلى ما إذا كان يجب على عامل المستخدم إرسال ملفات تعريف الارتباط من المجال الآخر في حالة الطلبات عبر المنشأ. الإعدادات الافتراضية للخطأ. |
تفاصيل الخاصية
abortSignal
agent
NODEJS فقط
خيار عقدة فقط لتوفير http.Agent/https.Agentمخصص .
لا يفعل شيئا عند التشغيل في المستعرض.
agent?: Agent
قيمة الخاصية
allowInsecureConnection
تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
allowInsecureConnection?: boolean
قيمة الخاصية
boolean
body
disableKeepAlive
إذا كان لا ينبغي إعادة استخدام الاتصال.
disableKeepAlive?: boolean
قيمة الخاصية
boolean
enableBrowserStreams
المستعرض فقط
خيار مستعرض فقط لتمكين تدفقات المستعرض. إذا تم تعيين هذا الخيار وكانت الاستجابة عبارة عن دفق، فسيكون للاستجابة خاصية browserStream بدلا من blobBody التي ستكون غير معرفة.
القيمة الافتراضية خاطئة
enableBrowserStreams?: boolean
قيمة الخاصية
boolean
formData
headers
method
multipartBody
onDownloadProgress
رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.
onDownloadProgress?: (progress: TransferProgressEvent) => void
قيمة الخاصية
(progress: TransferProgressEvent) => void
onUploadProgress
رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.
onUploadProgress?: (progress: TransferProgressEvent) => void
قيمة الخاصية
(progress: TransferProgressEvent) => void
proxySettings
requestId
معرف فريد للطلب. يستخدم للتسجيل والتتبع.
requestId: string
قيمة الخاصية
string
requestOverrides
خيارات إضافية لتعيينها عند الطلب. يوفر هذا طريقة لتجاوز الخصائص الموجودة أو توفير خصائص الطلب التي لم يتم الإعلان عنها.
للتعرف على الخصائص الصالحة المحتملة، راجع
- خيارات NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback
- طلب المتصفحInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
تحذير: ستقوم الخيارات المحددة هنا بتجاوز أي خصائص تحمل نفس الأسماء عند إرسال الطلب بواسطة HttpClient.
requestOverrides?: Record<string, unknown>
قيمة الخاصية
Record<string, unknown>
streamResponseStatusCodes
قائمة رموز حالة الاستجابة التي يجب التعامل مع نص PipelineResponse المقابل لها كتدفق. عندما تحتوي streamResponseStatusCodes على القيمة Number.POSITIVE_INFINITY سيتم التعامل مع أي حالة على أنها دفق.
streamResponseStatusCodes?: Set<number>
قيمة الخاصية
Set<number>
timeout
عدد المللي ثانية التي يمكن أن يستغرقها الطلب قبل إنهائه تلقائيا.
إذا تم إنهاء الطلب، يتم طرح AbortError.
الإعدادات الافتراضية إلى 0، مما يعطل المهلة.
timeout: number
قيمة الخاصية
number
tlsSettings
tracingOptions
خيارات التتبع لاستخدامها لأي امتدادات تم إنشاؤها.
tracingOptions?: OperationTracingOptions
قيمة الخاصية
url
عنوان URL لتقديم الطلب إليه.
url: string
قيمة الخاصية
string
withCredentials
يشير إلى ما إذا كان يجب على عامل المستخدم إرسال ملفات تعريف الارتباط من المجال الآخر في حالة الطلبات عبر المنشأ. الإعدادات الافتراضية للخطأ.
withCredentials: boolean
قيمة الخاصية
boolean