Búsqueda de sitios web

javascript - Soportando múltiples propiedades en funciones dentro de un archivo `.d.ts`


Estoy creando un archivo de declaración de TypeScript para una biblioteca escrita en JavaScript, para esta tarea estoy experimentando un problema una y otra vez. La biblioteca de JavaScript en cuestión repite el siguiente patrón en varios lugares.

const commandList = [
  "run-like-nuts",
  "some-more-commands",
  "another-nice-command",
  "power-commmand",
  // lots more commands like this
  // in this list 
];


function commandRunner(...args) {
  // Does some internal work based on ...args 
  // returns type Promise<string>
}

commandList.forEach(command => {
  Object.defineProperty(commandRunner, command, {
    value: function(command, ...args) {
      return commandRunner(command, ...args);
    }
  )); 
});

¿Cómo puedo definir tipos para la función commandRunner de manera que cuando la use en TypeScript sea invocable y tenga propiedades en la commandList, que como es evidente en el ejemplo anterior, también se vuelven invocables.

Hasta ahora, mi intento dado mi limitado conocimiento de TypeScript ha sido el siguiente intento, pero esto no resuelve el problema. ¿Cómo puedo resolver esto?

type ArgsType: string | Object;

type commandList = [
  "run-like-nuts",
  "some-more-commands",
  "another-nice-command",
  "power-commmand",
  // lots more commands like this
  // in this list 
];

export default (function commandRunner(...args: ArgsType[]) {}) & {
  [command: Command]: (command: Command,...args: ArgsType[]) => Promise<string>
}

Respuesta #1

Deberías mantener el commandList como un arreglo para que podamos usarlo tanto en tiempo de ejecución como en tiempo de compilación. Para hacer que los literales de cadena estén disponibles para su uso en la tipificación, tenemos que definirlo con as const.

const commandList = [
  "run-like-nuts",
  "some-more-commands",
  "another-nice-command",
  "power-commmand",
  // lots more commands like this
  // in this list 
] as const;

Para el tipo de commandRunner podemos mapear sobre los literales de cadena en commandList.

type CommandRunner = ((...args: ArgsType[]) => Promise<string>) & { 
  [Command in typeof commandList[number]]: 
    (command: Command,...args: ArgsType[]) => Promise<string> 
}

Parque infantil