microsoft / microsoft/TypeScript
[libdom] Allow Response / Request to be generics
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
Suggestion
🔍 Search Terms
request, response, libdom, generic, generics, type parameters
✅ Viability Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
Similar to the FormData request by @wesbos in https://github.com/microsoft/TypeScript/issues/43797, it would be great if the Request and Response globals could also accept generic type parameters.
This will become more relevant as more frameworks continue to increase their usage of these standard globals, also in Node.js.
Consider the following example of an App Route handler in Next.js (handling a POST request to an API route):
export async function POST(request: Request): Response {
const body = await request.json();
// ^? const body: any ❌
return new Response(JSON.stringify({
abc: 123, // ❌ POST function return type cannot check type of response body object
}))
}
What would be amazing would be something similar to this:
type RequestBody = { zzz: number };
type ResponseBody = { abc: number };
export async function POST(request: Request<RequestBody>): Response<ResponseBody> {
const body = await request.json();
// ^? const body: { zzz: number } ✅
return new Response(JSON.stringify({
abc: 123, // ✅ type checked
}))
}
📃 Motivating Example
The second example in the Suggestion section above.
💻 Use Cases
For typing the response body of API routes
Prior Art
@types/express:RequestandResponsetypes - which both accept a generic type parameter.- Next.js:
NextResponseaccepting generic parameters
Workaround
Response
Wasn't able to find a nice workaround for typing the body of a Response yet.
Request
Using Type Assertion / casting via as:
type RequestBody = { zzz: string };
export async function POST(request: Request) {
const body = await request.json() as RequestBody;
Caveats
- Arguably, the
Requestbody is unknown until runtime, so this is better handled instead with Zod or some other runtime validation. But for quick/simple projects without this validation, it's nice to be able to type the request body type.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando le dichiarazioni lib.dom per i globali Request e Response e la proposta correlata di FormData nell’issue #43797. Chiarisci in che modo i tipi di body generici dovrebbero influire su request.json() e sul tipaggio delle risposte, preservando la compatibilità. Il lavoro è completato quando i parametri generici proposti e il loro comportamento sono specificati e coperti dai test di dichiarazione TypeScript pertinenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- api, web-dev
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100