打字稿中重载参数的命名约定

Question

我需要一个将参数作为字符串或字符串数组作为参数的函数。

delete(keyOrKeys : string | string[]){
   if(Array.isArray(keyOrKeys){
     // delete all keys in array
   } else {
     // delete single key.
   }
}

所以，我需要遵循良好的命名约定。我应该使用什么名称代替 'keyOrkeys'。还是刚刚好？

Answer 1

如果您使用真正的重载（不仅仅是一个实现）为该函数创建定义，您可以独立地为每个重载命名参数，例如：

delete(key : string): void; // or whatever you are returning
delete(keys : string[]): void;
// this is useful for calling inside another function with union parameter
delete(keyOrKeys : string | string[]): void;

delete(keyOrKeys : string | string[]){
   if(Array.isArray(keyOrKeys){
     // delete all keys in array
   } else {
     // delete single key.
   }
}

Answer 2

首先delete是Js中的保留关键字。也许使用 deleteKeys。

打字稿中重载参数的命名约定

Naming conventions for overload parameters in typescript

conventions

typescript