microsoft / microsoft/TypeScript
Narrower (literal) type for Function.prototype.name if function is const
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
Search Terms
ES6 function name, const assertions, as const, function as const
Suggestion
I would like to see the name property of functions to be available at compile time if the given function is a const expression, e.g.:
class Test {
public a() { console.log("Test.a"); }
public b() { console.log("Test.b"); }
}
type FunctionWithName<N> = (...args: any[]) => any & { readonly name: N };
function replaceFunction<T, K extends keyof T>(target: T, fn: FunctionWithName<K>) {
target[fn.name] = fn;
}
// proposed inline syntax
let testInstance = new Test();
replaceFunction(testInstance, function a() { console.log("Replacement.a"); })
// proposed "as const" syntax
const newB = function b() {
console.log("Replacement.b");
} as const;
replaceFunction(testInstance, newB);
// example of a compile time error since "c" is not assignable to "a" | "b"
replaceFunction(testInstance, function c() { console.log("Replacement.a"); })
Use Cases
My use case is a function like shown above, where I would like to have static type checking available, without having to specify the extra parameter that specifies the function name to replace, e.g. compare:
// current syntax:
replaceFunction(testInstance, "a", function a() { /* ... */ });
// proposed syntax:
replaceFunction(testInstance, function a() { /* ... */ });
Examples
let myObject = {
a: () => "a",
b: () => "b"
}
// fictional "mocking" library:
// this syntax can only validate that "a" is in "myObject" through the const "a" parameter
mockingLibrary.mock(myObject, "a", function a() { return "different value" });
// proposed style, using Function.prototype.name
mockingLibrary.mock(myObject, function a() { return "different value" });
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, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comience revisando los ejemplos de la propuesta relacionados con Function.prototype.name, const expressions y las llamadas genéricas a replaceFunction. Determine las implicaciones para el sistema de tipos y la compatibilidad; después, defina pruebas que demuestren que los nombres de función literales se conservan y que los nombres no válidos se rechazan sin cambiar el JavaScript emitido.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- compilers
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 30/100