microsoft / microsoft/TypeScript

Better types for UrlSearchParams

Abierto
#43,738 7 comentarios 13 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Domain: lib.d.ts Experience Enhancement Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

Suggestion

🔍 Search Terms

Restrictive typing on UrlSearchParams

✅ 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

declare var URLSearchParams: {
    prototype: URLSearchParams;
    // new(init?: string[][] | Record<string, string> | string | URLSearchParams): URLSearchParams;
    new(init?: 
        | string
        | URLSearchParams
        | Record<string | number, string | number | boolean | string[] | number[] | boolean[]>
        | [string | number | boolean, string | number | boolean | string[] | number[] | boolean[]][]): URLSearchParams;
    toString(): string;
};

📃 Motivating Example

The actual typing design is more restrictive than the Javascript runtime itself.

💻 Use Cases

More possibilities to create strict typed UrlSearchParams objects:

let url = 'https://developer.microsoft.com'

const queryParams = new UrlSearchParams({
  key1: ["v1", "v2"],
  key2: ["v1", "v2", "v3"]
})

url = url + '?' + queryParams // https://developer.microsoft.com?key1=v1,v2&key2=v1,v2,v3

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza localizando la declaración de URLSearchParams en la biblioteca estándar y revisa la tipificación de su constructor comparándola con la sobrecarga propuesta y los ejemplos que la motivan. Comprueba las definiciones de tipos circundantes y las pruebas de tipos relevantes antes de decidir qué formas de entrada se admitirán; se considera terminado cuando las declaraciones aceptan las formas más estrictas previstas sin cambiar el JavaScript emitido ni el comportamiento en tiempo de ejecución.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, typescript
Área
api, web-dev
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
32/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.