Skip to content

feat(types): opt-in flat NitroFetchRequest to bound $fetch type instantiation #4477

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

Open
Killian-Aidalinfo wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −1
Open

feat(types): opt-in flat NitroFetchRequest to bound $fetch type instantiation #4477

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion src/types/fetch/fetch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,24 @@ import type { MatchedRoutes } from "./_match.ts";
// An interface to extend in a local project
export interface InternalApi {}

// Opt-in configuration interface to augment in a local project, e.g.
// declare module "nitropack" {
// interface NitroFetchConfig { flatRequest: true }
// }
export interface NitroFetchConfig {}

// TODO: upgrade to uppercase for h3 v2 types and web consistency
type RouterMethod = Lowercase<HTTPMethod>;

export type NitroFetchRequest =
type TypedNitroFetchRequest =
| Exclude<keyof InternalApi, `/_${string}` | `/api/_${string}`>
| Exclude<FetchRequest, string>
| (string & {});

export type NitroFetchRequest = NitroFetchConfig extends { flatRequest: true }
? string
: TypedNitroFetchRequest;

export type MiddlewareOf<
Route extends string,
Method extends RouterMethod | "default",
Expand Down