ประเภท & ข้อผิดพลาด
จัดระเบียบขอบเขตประเภทของสัญญา HTTP request และวัตถุข้อผิดพลาดมาตรฐาน.
OpenApiPathsLike
ts
ข้อจำกัดในเวลา compile เองกว้างขวาง วัตถุเป็น. การอนุมานประเภทจริงคือPaths[path][method].parametersและ requestBody.content["application/json"]จะถูกเฉพาะเจาะจงเมื่อมี property แบบ OpenAPI-style.
ServiceArguments<Paths, TPath, TMethod, R>
| Name | Type | Default | คำอธิบาย |
|---|---|---|---|
url จำเป็น | TPath | - | Paths key. |
method จำเป็น | TMethod | - | Paths[TPath] method key. |
pathVariable | parameters.path | Record | - | path parameters가 있으면 해당 타입, 없으면 일반 Record fallback. |
queryString | parameters.query | Record | - | query parameters가 있으면 해당 타입, 없으면 일반 Record fallback. |
body | requestBody application/json | unknown | - | JSON request body schema가 있으면 해당 타입. |
resultInterceptor | (response: Response) => Promise<R> | - | 직접 response parser. |
headers | Readonly<Record<string, string>> | - | 요청별 headers. |
CacheForService<CacheName>
| Name | Type | Default | คำอธิบาย |
|---|---|---|---|
cacheTime จำเป็น | number | - | CSR shareReplay windowTime 또는 SSR revalidate 기준 milliseconds. |
cacheSize | number | - | CSR shareReplay bufferSize. SSR에서는 사용하지 않습니다. |
cacheName จำเป็น | CacheName | - | cache key prefix와 Next.js cache tag. |
HttpResponseError<Args>
ts
response
원본 Fetch Response.
args
실패한 ServiceArguments.
data
JSON 또는 text로 파싱한 에러 body.
status
response.status getter.
message
body.message → defaultErrorMessage → 기본 HTTP ERROR 문자열 순서로 결정됩니다.
พฤติกรรมที่เข้ากันได้กับข้อผิดพลาด
resultType วัตถุ
ถ้า body ของข้อผิดพลาดเป็นวัตถุและ
resultType property เป็น truthyHttpResponseErrorจะโยน body object เองโดยไม่ห่อหุ้ม. ในกรณีนี้isHttpResponseError()คือ false.ข้อผิดพลาดเครือข่าย·รันไทม์
core callApi จะส่งต่อ JavaScript Error แทน HttpResponseError
{ message, stack } โดยแปลงเป็นวัตถุ. ค่าที่โยนอื่น ๆ จะถูกส่งต่อโดยตรง.