Skip to content

[feat]: parseAs options reports correct data type #1428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Dec 6, 2023
Merged

[feat]: parseAs options reports correct data type #1428

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
34f0b32
get queries
HugeLetters Nov 5, 2023
d94905e
tets updates
HugeLetters Nov 5, 2023
7926e49
stumped :|
HugeLetters Nov 6, 2023
30f9383
Add parseAs inference
drwpow Nov 18, 2023
8da1b0b
minor fix for stream reponses
HugeLetters Nov 28, 2023
0cf7012
add satisfies clauses to tests
HugeLetters Nov 28, 2023
762efca
fix tests
HugeLetters Nov 28, 2023
e2adb20
simplify filterKeys type helper
HugeLetters Nov 28, 2023
eeebf63
parseAs Record type
HugeLetters Nov 28, 2023
c2b2da7
use fetchOptions for generic
HugeLetters Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions packages/openapi-fetch/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ export type QuerySerializer<T> = (
export type BodySerializer<T> = (body: OperationRequestBodyContent<T>) => any;

export type ParseAs = "json" | "text" | "blob" | "arrayBuffer" | "stream";
export type ParseAsResponse<T, K> = K extends ParseAs
? {
json: T;
text: Awaited<ReturnType<Response["text"]>>;
blob: Awaited<ReturnType<Response["blob"]>>;
arrayBuffer: Awaited<ReturnType<Response["arrayBuffer"]>>;
stream: Response["body"];
}[K]
: T;

export interface DefaultParamsOption {
params?: {
Expand All @@ -62,9 +71,12 @@ export type RequestBodyOption<T> = OperationRequestBodyContent<T> extends never

export type FetchOptions<T> = RequestOptions<T> & Omit<RequestInit, "body">;

export type FetchResponse<T> =
export type FetchResponse<T, O extends FetchOptions<any>> =
| {
data: FilterKeys<SuccessResponse<ResponseObjectMap<T>>, MediaType>;
data: ParseAsResponse<
FilterKeys<SuccessResponse<ResponseObjectMap<T>>, MediaType>,
O["parseAs"]
>;
error?: never;
response: Response;
}
Expand All @@ -86,13 +98,12 @@ export default function createClient<Paths extends {}>(
clientOptions?: ClientOptions,
): {
/** Call a GET endpoint */
GET<P extends PathsWithMethod<Paths, "get">>(
GET<
P extends PathsWithMethod<Paths, "get">,
O extends FetchOptions<FilterKeys<Paths[P], "get">> = {},
>(
url: P,
...init: HasRequiredKeys<
FetchOptions<FilterKeys<Paths[P], "get">>
> extends never
? [(FetchOptions<FilterKeys<Paths[P], "get">> | undefined)?]
: [FetchOptions<FilterKeys<Paths[P], "get">>]
...init: HasRequiredKeys<O> extends never ? [O?] : [O]
): Promise<
FetchResponse<
"get" extends infer T
Expand All @@ -101,7 +112,8 @@ export default function createClient<Paths extends {}>(
? Paths[P][T]
: unknown
: never
: never
: never,
O
>
>;
/** Call a PUT endpoint */
Expand Down