@typespec/ts-http-runtime package

الفصول

يتم طرح هذا الخطأ عند إجهاض عملية غير متزامنة. تحقق من هذا الخطأ عن طريق اختبار name أن خاصية اسم الخطأ تتطابق مع "AbortError".

مثال

import { AbortError } from "@typespec/ts-http-runtime";

async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
  if (options.abortSignal.aborted) {
    throw new AbortError();
  }

  // do async work
}

const controller = new AbortController();
controller.abort();

try {
  doAsyncWork({ abortSignal: controller.signal });
} catch (e) {
  if (e instanceof Error && e.name === "AbortError") {
    // handle abort error here.
  }
}

RestError

نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.

الواجهات

AddPolicyOptions	خيارات عند إضافة نهج إلى البنية الأساسية لبرنامج ربط العمليات التجارية. يستخدم للتعبير عن التبعيات على النهج الأخرى.
AdditionalPolicyConfig	يستخدم لتكوين نهج إضافية تمت إضافتها إلى البنية الأساسية لبرنامج ربط العمليات التجارية عند الإنشاء.
Agent	واجهة متوافقة مع `http.Agent`NodeJS. نريد تجنب إعادة تصدير الواجهة الفعلية بشكل عام، لأنها قد تختلف عبر إصدارات وقت التشغيل.
ApiKeyAuthScheme	يمثل مخطط مصادقة مفتاح واجهة برمجة التطبيقات. تتطلب مصادقة مفتاح واجهة برمجة التطبيقات توفير مفتاح مع كل طلب. يمكن توفير المفتاح في مواقع مختلفة: معلمة الاستعلام أو الرأس أو ملف تعريف الارتباط.
ApiKeyCredential	بيانات الاعتماد لمصادقة مفتاح واجهة برمجة التطبيقات. يوفر مفتاح واجهة برمجة التطبيقات الذي سيتم استخدامه في رؤوس الطلبات.
AuthorizationCodeFlow	يمثل تكوين تدفق رمز التفويض OAuth2.
BasicAuthScheme	يمثل نظام مصادقة HTTP الأساسي. يتطلب نظام المصادقة الأساسي توفير اسم مستخدم وكلمة مرور مع كل طلب. يتم ترميز بيانات الاعتماد باستخدام Base64 ويتم تضمينها في رأس التخويل.
BasicCredential	بيانات الاعتماد لمصادقة HTTP الأساسية. يوفر اسم المستخدم وكلمة المرور لرؤوس المصادقة الأساسية.
BearerAuthScheme	يمثل نظام مصادقة حامل HTTP. يتطلب نظام مصادقة الحامل توفير رمز مميز للحامل مع كل طلب. يتم تضمين الرمز المميز في رأس التفويض مع البادئة "حامل".
BearerTokenCredential	بيانات الاعتماد لمصادقة الرمز المميز للحامل.
BodyPart	جزء من نص الطلب في طلب متعدد الأجزاء.
Client	شكل عميل مستوى الراحة
ClientCredentialsFlow	يمثل تكوين تدفق بيانات اعتماد عميل OAuth2.
Debugger
FullOperationResponse	كائن برنامج التضمين لطلب واستجابة http. يتم تخزين الكائن الذي تم إلغاء تسلسله في الخاصية `parsedBody` عند تلقي نص الاستجابة في JSON.
GetBearerTokenOptions	الخيارات المستخدمة عند إنشاء وإرسال طلبات الرمز المميز لحامل هذه العملية.
GetOAuth2TokenOptions	الخيارات المستخدمة عند إنشاء طلبات الحصول على OAuth 2 وإرسالها لهذه العملية.
HttpClient	الواجهة المطلوبة لعميل يقوم بإجراء طلبات HTTP نيابة عن البنية الأساسية لبرنامج ربط العمليات التجارية.
HttpHeaders	يمثل مجموعة من عناوين HTTP على طلب/استجابة. يتم التعامل مع أسماء العناوين على أنها غير حساسة لحالة الأحرف.
ImplicitFlow	يمثل تكوين التدفق الضمني OAuth2.
KeyObject	واجهة متوافقة مع `tls.KeyObject`NodeJS. نريد تجنب إعادة تصدير الواجهة الفعلية بشكل عام، لأنها قد تختلف عبر إصدارات وقت التشغيل.
LogPolicyOptions	خيارات لتكوين logPolicy.
MultipartRequestBody	نص طلب يتكون من أجزاء متعددة.
NoAuthAuthScheme	يمثل نقطة نهاية أو عملية لا تتطلب مصادقة.
OAuth2AuthScheme	يمثل نظام مصادقة OAuth2 مع تدفقات محددة
OAuth2TokenCredential	بيانات الاعتماد لتدفقات مصادقة OAuth2.
OperationOptions	نوع الخيارات الأساسية لكافة العمليات.
OperationRequestOptions	الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.
PasswordFlow	يمثل تكوين تدفق كلمة مرور OAuth2.
PathParameterWithOptions	كائن يمكن تمريره كمعلمة مسار، ما يسمح بتعيين خيارات إضافية تتعلق بكيفية ترميز المعلمة.
Pipeline	يمثل مسارا لإجراء طلب HTTP إلى عنوان URL. يمكن أن يكون للبنية الأساسية لبرنامج ربط العمليات التجارية نهج متعددة لإدارة معالجة كل طلب قبل وبعد تقديمه إلى الخادم.
PipelineOptions	يحدد الخيارات المستخدمة لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP لعميل SDK.
PipelinePolicy	يعالج نهج البنية الأساسية لبرنامج ربط العمليات التجارية طلبا أثناء تنقله عبر البنية الأساسية لبرنامج ربط العمليات التجارية. من الناحية المفاهيمية هو برنامج وسيط يسمح بتعديل الطلب قبل تقديمه بالإضافة إلى الاستجابة عند تلقيه.
PipelineRequest	بيانات التعريف حول طلب يتم إجراؤه بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية.
PipelineRequestOptions	إعدادات لتهيئة طلب. يكاد يكون مكافئا ل Partial<PipelineRequest>، ولكن عنوان url إلزامي.
PipelineResponse	بيانات التعريف حول استجابة تم تلقيها بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية.
PipelineRetryOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
ProxySettings	خيارات لتكوين وكيل للطلبات الصادرة (Node.js فقط).
PxfObject	واجهة متوافقة مع `tls.PxfObject`NodeJS. نريد تجنب إعادة تصدير الواجهة الفعلية بشكل عام، لأنها قد تختلف عبر إصدارات وقت التشغيل.
RedirectPolicyOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
ResourceMethods	تعريف الأساليب التي يمكن استدعاؤها على مورد
RestErrorOptions	الخيارات التي يدعمها RestError.
TelemetryOptions	تحديد الخيارات المستخدمة لتكوين بيانات تتبع الاستخدام الشائعة ومعلومات التتبع
TlsSettings	يمثل شهادة لمصادقة TLS.
UserAgentPolicyOptions	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

النوع أسماء مستعارة

AuthScheme	نوع الاتحاد لجميع مخططات المصادقة المدعومة
ClientCredential	نوع الاتحاد لجميع بيانات اعتماد المصادقة المدعومة.
ClientOptions	الخيارات العامة التي يمكن لعميل مستوى الراحة اتخاذها
EncodingType	نوع ترميز الحرف المعتمد
FormDataMap	كائن بسيط يوفر بيانات النموذج، كما لو كان من نموذج مستعرض.
FormDataValue	يمكن أن يكون كل إدخال بيانات نموذج سلسلة أو كائن ثنائي كبير الحجم أو ملف. إذا كنت ترغب في تمرير ملف باسم ولكن ليس لديك حق الوصول إلى فئة ملف، يمكنك استخدام مساعد createFile لإنشاء ملف.
HttpBrowserStreamResponse	استجابة Http أي نص هو كائن دفق NodeJS
HttpMethods	أساليب HTTP المدعومة لاستخدامها عند تقديم الطلبات.
HttpNodeStreamResponse	استجابة Http أي نص هو كائن دفق NodeJS
HttpResponse	يمثل شكل HttpResponse
OAuth2Flow	نوع الاتحاد لجميع تدفقات OAuth2 المدعومة
PathParameters	نوع المساعد المستخدم للكشف عن المعلمات في نص قالب مسار محاط {} سيعتبر معلمة مسار
PathUnchecked	تعريف توقيع pathUnchecked.
PathUncheckedResponse	اكتب لاستخدامه مع pathUnchecked، ويتجاوز نوع النص الأساسي إلى أي للسماح بالمرونة
PipelinePhase	يتم تنفيذ النهج على مراحل. أمر التنفيذ هو: مرحلة التسلسل النهج ليست في مرحلة إلغاء تسلسل المرحلة مرحلة إعادة المحاولة مرحلة التوقيع
RawHttpHeaders	يتم تمثيل مجموعة HttpHeaders ككائن JSON بسيط.
RawHttpHeadersInput	مجموعة HttpHeaders للإدخل، ممثلة ككائن JSON بسيط.
RawResponseCallback	دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات.
RequestBodyType	أنواع الهيئات المدعومة بناء على الطلب. NodeJS.ReadableStream و () => NodeJS.ReadableStream هي Node only. Blob وReadableStream<Uint8Array> و() => ReadableStream<Uint8Array> هي مستعرض فقط.
RequestParameters	شكل معلمات الطلب الافتراضية، قد يتم تجاوز ذلك بواسطة أنواع الطلبات المحددة لتوفير أنواع قوية
SendRequest	واجهة بسيطة لإجراء طلب البنية الأساسية لبرنامج ربط العمليات التجارية وتلقي استجابة.
StreamableMethod	يحدد نوع أسلوب يدعم الحصول على نص الاستجابة كتدفق أولي
TransferProgressEvent	تم إطلاقه استجابة للتقدم في التحميل أو التنزيل.
TypeSpecRuntimeClientLogger	TypeSpecRuntimeClientLogger هي دالة يمكنها تسجيل الدخول إلى مستوى خطورة مناسب.
TypeSpecRuntimeLogLevel	مستويات السجل التي يدعمها المسجل. مستويات السجل بترتيب معظم الإسهاب إلى الأقل إسهاب هي: مطول معلومات ‏‏تحذير خطأ

الوظائف

TypeSpecRuntimeLogger(any[])	تمكين التسجيل على الفور على مستوى السجل المحدد. إذا لم يتم تحديد أي مستوى، يتم تعطيل التسجيل.
createDefaultHttpClient()	إنشاء HttpClient الصحيح للبيئة الحالية.
createEmptyPipeline()	إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية فارغة تماما. مفيد لاختبار أو إنشاء واحد مخصص.
createHttpHeaders(RawHttpHeadersInput)	إنشاء كائن يفي بواجهة `HttpHeaders`.
createPipelineRequest(PipelineRequestOptions)	إنشاء طلب مسار جديد مع الخيارات المحددة. هذا الأسلوب هو للسماح بالإعداد السهل للقيم الافتراضية وليس مطلوبا.
createRestError(PathUncheckedResponse)	إنشاء خطأ بقية من استجابة PathUnchecked
createRestError(string, PathUncheckedResponse)	إنشاء خطأ بقية من رسالة خطأ واستجابة PathUnchecked
getClient(string, ClientOptions)	إنشاء عميل بمسار افتراضي
getLogLevel()	استرداد مستوى السجل المحدد حاليا.
isRestError(unknown)	Typeguard ل RestError
operationOptionsToRequestParameters(OperationOptions)	دالة المساعد لتحويل OperationOptions إلى RequestParameters
setLogLevel(TypeSpecRuntimeLogLevel)	استرداد مستوى السجل المحدد حاليا.
stringToUint8Array(string, EncodingType)	المساعد الذي يحول السلسلة إلى صفيف وحدات بايت محددة مرمزة بأحرف.
uint8ArrayToString(Uint8Array, EncodingType)	المساعد الذي يحول وحدات البايت مع ترميز حرف معين إلى سلسلة

تفاصيل الوظيفة

TypeSpecRuntimeLogger(any[])

تمكين التسجيل على الفور على مستوى السجل المحدد. إذا لم يتم تحديد أي مستوى، يتم تعطيل التسجيل.

function TypeSpecRuntimeLogger(args: any[])

المعلمات

args: any[]

createDefaultHttpClient()

إنشاء HttpClient الصحيح للبيئة الحالية.

function createDefaultHttpClient(): HttpClient

المرتجعات

HttpClient

createEmptyPipeline()

إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية فارغة تماما. مفيد لاختبار أو إنشاء واحد مخصص.

function createEmptyPipeline(): Pipeline

المرتجعات

Pipeline

createHttpHeaders(RawHttpHeadersInput)

إنشاء كائن يفي بواجهة HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

المعلمات

rawHeaders: RawHttpHeadersInput

كائن بسيط يمثل الرؤوس الأولية

المرتجعات

HttpHeaders

createPipelineRequest(PipelineRequestOptions)

إنشاء طلب مسار جديد مع الخيارات المحددة. هذا الأسلوب هو للسماح بالإعداد السهل للقيم الافتراضية وليس مطلوبا.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

المعلمات

options: PipelineRequestOptions

خيارات إنشاء الطلب باستخدام.

المرتجعات

PipelineRequest

createRestError(PathUncheckedResponse)

إنشاء خطأ بقية من استجابة PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

المعلمات

response: PathUncheckedResponse

المرتجعات

RestError

createRestError(string, PathUncheckedResponse)

إنشاء خطأ بقية من رسالة خطأ واستجابة PathUnchecked

function createRestError(message: string, response: PathUncheckedResponse): RestError

المعلمات

message: string

response: PathUncheckedResponse

المرتجعات

RestError

getClient(string, ClientOptions)

إنشاء عميل بمسار افتراضي

function getClient(endpoint: string, clientOptions?: ClientOptions): Client

المعلمات

endpoint: string

نقطة النهاية الأساسية للعميل

clientOptions: ClientOptions

المرتجعات

Client

getLogLevel()

استرداد مستوى السجل المحدد حاليا.

function getLogLevel(): TypeSpecRuntimeLogLevel | undefined

المرتجعات

TypeSpecRuntimeLogLevel | undefined

isRestError(unknown)

Typeguard ل RestError

function isRestError(e: unknown): e

المعلمات

e: unknown

شيء ما تم التقاطه بواسطة عبارة catch.

المرتجعات

operationOptionsToRequestParameters(OperationOptions)

دالة المساعد لتحويل OperationOptions إلى RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

المعلمات

options: OperationOptions

الخيارات التي تستخدمها الطبقة النمطية لإرسال الطلب

المرتجعات

RequestParameters

نتيجة التحويل في RequestParameters لطبقة RLC

setLogLevel(TypeSpecRuntimeLogLevel)

استرداد مستوى السجل المحدد حاليا.

function setLogLevel(logLevel?: TypeSpecRuntimeLogLevel)

المعلمات

logLevel: TypeSpecRuntimeLogLevel

stringToUint8Array(string, EncodingType)

المساعد الذي يحول السلسلة إلى صفيف وحدات بايت محددة مرمزة بأحرف.

function stringToUint8Array(value: string, format: EncodingType): Uint8Array

المعلمات

value: string

السلسلة التي سيتم تحويلها

format: EncodingType

التنسيق الذي نستخدمه لفك ترميز القيمة

المرتجعات

Uint8Array

uint8array

uint8ArrayToString(Uint8Array, EncodingType)

المساعد الذي يحول وحدات البايت مع ترميز حرف معين إلى سلسلة

function uint8ArrayToString(bytes: Uint8Array, format: EncodingType): string

المعلمات

bytes: Uint8Array

وحدات البايت uint8array

format: EncodingType

التنسيق الذي نستخدمه لترميز البايت

المرتجعات

string

سلسلة من السلسلة المشفرة

الملاحظات

هل كانت هذه الصفحة مفيدة؟

مشاركة عبر

@typespec/ts-http-runtime package

الفصول

الواجهات

النوع أسماء مستعارة

الوظائف

تفاصيل الوظيفة

TypeSpecRuntimeLogger(any[])

المعلمات

createDefaultHttpClient()

المرتجعات

createEmptyPipeline()

المرتجعات

createHttpHeaders(RawHttpHeadersInput)

المعلمات

المرتجعات

createPipelineRequest(PipelineRequestOptions)

المعلمات

المرتجعات

createRestError(PathUncheckedResponse)

المعلمات

المرتجعات

createRestError(string, PathUncheckedResponse)

المعلمات

المرتجعات

getClient(string, ClientOptions)

المعلمات

المرتجعات

getLogLevel()

المرتجعات

isRestError(unknown)

المعلمات

المرتجعات

operationOptionsToRequestParameters(OperationOptions)

المعلمات

المرتجعات

setLogLevel(TypeSpecRuntimeLogLevel)

المعلمات

stringToUint8Array(string, EncodingType)

المعلمات

المرتجعات

uint8ArrayToString(Uint8Array, EncodingType)

المعلمات

المرتجعات

الملاحظات