Loại & Lỗi
Tổ chức ranh giới loại của hợp đồng yêu cầu HTTP và đối tượng lỗi tiêu chuẩn.
OpenApiPathsLike
ts
export type OpenApiPathsLike = object;Ràng buộc thời gian biên dịch tự nó là rộng. đối tượngThực tế suy diễn loại làPaths[path][method].parametersvà requestBody.content["application/json"]được cụ thể hóa khi có thuộc tính kiểu OpenAPI tương tự.
ServiceArguments<Paths, TPath, TMethod, R>
| Name | Type | Default | Mô tả |
|---|---|---|---|
url bắt buộc | TPath | - | Paths key. |
method bắt buộc | 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 | Mô tả |
|---|---|---|---|
cacheTime bắt buộc | number | - | CSR shareReplay windowTime 또는 SSR revalidate 기준 milliseconds. |
cacheSize | number | - | CSR shareReplay bufferSize. SSR에서는 사용하지 않습니다. |
cacheName bắt buộc | CacheName | - | cache key prefix와 Next.js cache tag. |
HttpResponseError<Args>
ts
client.callApi<Response>({
url: "/profile/me",
method: "get",
}).subscribe({
error: (error) => {
if (isHttpResponseError(error)) {
console.log(error.status);
console.log(error.response);
console.log(error.args);
console.log(error.data);
}
},
});response
원본 Fetch Response.
args
실패한 ServiceArguments.
data
JSON 또는 text로 파싱한 에러 body.
status
response.status getter.
message
body.message → defaultErrorMessage → 기본 HTTP ERROR 문자열 순서로 결정됩니다.
Hành vi tương thích lỗi
đối tượng resultType
nếu body lỗi là đối tượng và
resultType thuộc tính là truthy thìHttpResponseErrorném chính đối tượng body mà không bọc lại. Trong trường hợp nàyisHttpResponseError()là false.Lỗi mạng·thời gian chạy
Hàm core callApi sẽ chuyển đổi thành Lỗi JavaScript không phải HttpResponseError.
{ message, stack } Chuyển đổi thành đối tượng. Các giá trị ném khác sẽ được truyền nguyên vẹn.