如何在省略一些其他可选参数的同时在TypeScript中传递可选参数？

Question

鉴于以下签名：

export interface INotificationService {
    error(message: string, title?: string, autoHideAfter?: number);
}

如何调用函数error() 而不是指定title参数，而是将autoHideAfter设置为1000？

Answer 1

根据documentation中的说明，使用undefined：

export interface INotificationService {
    error(message: string, title?: string, autoHideAfter? : number);
}

class X {
    error(message: string, title?: string, autoHideAfter?: number) {
        console.log(message, title, autoHideAfter);
    }
}

new X().error("hi there", undefined, 1000);

Playground link

Answer 2

不幸的是，在TypeScript中没有这样的东西（更多细节在这里：https://github.com/Microsoft/TypeScript/issues/467）

但要解决这个问题，你可以将你的参数更改为一个界面：

export interface IErrorParams {
  message: string;
  title?: string;
  autoHideAfter?: number;
}

export interface INotificationService {
  error(params: IErrorParams);
}

//then to call it:
error({message: 'msg', autoHideAfter: 42});

Answer 3

您可以?使用可选变量，或者...有多个可选变量，例如：

function details(name: string, country="CA", address?: string, ...hobbies: string) {
    // ...
}

在上面：

• name是必需的
• country是必需的，并且具有默认值
• address是可选的
• hobbies是一组可选参数

Answer 4

这与@Brocco的答案几乎相同，但略有不同：仅传递对象中的可选参数。（并且还使params对象可选）。

它最终有点像Python的kwargs，但不完全是。

export interface IErrorParams {
  title?: string;
  autoHideAfter?: number;
}

export interface INotificationService {
  // make params optional so you don't have to pass in an empty object
  // in the case that you don't want any extra params
  error(message: string, params?: IErrorParams);
}

// all of these will work as expected
error('A message with some params but not others:', {autoHideAfter: 42});
error('Another message with some params but not others:', {title: 'StackOverflow'});
error('A message with all params:', {title: 'StackOverflow', autoHideAfter: 42});
error('A message with all params, in a different order:', {autoHideAfter: 42, title: 'StackOverflow'});
error('A message with no params at all:');

Answer 5

另一种方法是：

error(message: string, options?: {title?: string, autoHideAfter?: number});

因此，当您想省略title参数时，只需发送如下数据：

error('the message', { autoHideAfter: 1 })

我宁愿使用此选项，因为它允许我添加更多参数而不必发送其他参数。

Answer 6

您可以在接口上指定多个方法签名，然后在类方法上有多个方法重载：

interface INotificationService {
    error(message: string, title?: string, autoHideAfter?: number);
    error(message: string, autoHideAfter: number);
}

class MyNotificationService implements INotificationService {
    error(message: string, title?: string, autoHideAfter?: number);
    error(message: string, autoHideAfter?: number);
    error(message: string, param1?: (string|number), param2?: number) {
        var autoHideAfter: number,
            title: string;

        // example of mapping the parameters
        if (param2 != null) {
            autoHideAfter = param2;
            title = <string> param1;
        }
        else if (param1 != null) {
            if (typeof param1 === "string") {
                title = param1;
            }
            else {
                autoHideAfter = param1;
            }
        }

        // use message, autoHideAfter, and title here
    }
}

现在所有这些都可行：

var service: INotificationService = new MyNotificationService();
service.error("My message");
service.error("My message", 1000);
service.error("My message", "My title");
service.error("My message", "My title", 1000);

... error的{​​{1}}方法将包含以下选项：

Playground

Answer 7

您可以创建一个基于错误参数接受一个对象参数的辅助方法

 error(message: string, title?: string, autoHideAfter?: number){}

 getError(args: { message: string, title?: string, autoHideAfter?: number }) {
    return error(args.message, args.title, args.autoHideAfter);
 }

Answer 8

在 TS 中，您还可以将参数设置为 Object 并使对象的值可选，这样您就不必定义每个参数，只需定义您想使用的参数即可。

public functionBeingCalled(obj: {status?: number, error?: string, message?: string}) {
  if(obj.message) { console.log(obj.message) }
}

this.functionBeingCalled({message: 'Error Detected'})

Answer 9

您可以在没有界面的情况下执行此操作。

class myClass{
  public error(message: string, title?: string, autoHideAfter? : number){
    //....
  }
}

使用?运算符作为可选参数。

Answer 10

你可以尝试将title设置为null。

这对我有用。

错误（'这是'，null，1000）