设置作为参数传递的 TypeScript 对象的默认值

Question

function sayName(params: {firstName: string; lastName?: string}) {
    params.lastName = params.lastName || 'smith';  // <<-- any better alternative to this?
    var name = params.firstName + params.lastName
    alert(name);
}

sayName({firstName: 'bob'});

我曾想象过这样的事情可能会奏效：

function sayName(params: {firstName: string; lastName: string = 'smith'}) {

显然，如果这些是简单的参数，您可以这样做：

function sayName(firstName: string, lastName = 'smith') {
    var name = firstName + lastName;
    alert(name);
}

sayName('bob');

在coffeescript中，您可以访问条件存在运算符，因此可以这样做：

param.lastName ?= 'smith'

编译成javascript：

if (param.lastName == null) {
    param.lastName = 'smith';
}

Answer 1

Object destructuring 参数对象是上面许多答案的目标，Typescript 现在有方法使其更易于阅读和直观理解。

解构基础：通过解构对象，您可以通过键名从对象中选择属性。您可以定义任意少或任意多的属性，默认值由let {key = default} = object 的基本语法设置。

let {firstName, lastName = 'Smith'} = myParamsObject;

//Compiles to:
var firstName = myParamsObject.firstName, 
_a = myParamsObject.lastName, 
lastName = _a === void 0 ? 'Smith' : _a;

为参数对象编写接口、类型或类可提高可读性。

type FullName = {
  firstName: string;
   
  /** @defaultValue 'Smith' */
  lastName ? : string;
}

function sayName(params: FullName) {

  // Set defaults for parameter object
  var { firstName, lastName = 'Smith'} = params;

  // Do Stuff
  var name = firstName + " " + lastName;
  alert(name);
}

// Use it
sayName({
  firstName: 'Bob'
});

Answer 2

实际上，现在似乎有一个简单的方法。以下代码适用于 TypeScript 1.5：

function sayName({ first, last = 'Smith' }: {first: string; last?: string }): void {
  const name = first + ' ' + last;
  console.log(name);
}

sayName({ first: 'Bob' });

诀窍是首先将要从参数对象中选择的键放入括号中，key=value 表示任何默认值。紧随其后的是 : 和类型声明。

这与您尝试做的有点不同，因为您没有完整的 params 对象，而是有取消引用的变量。

如果你想让它成为可选的传递任何东西给函数，为类型中的所有键添加一个?，并在类型声明之后添加一个默认的={}：

function sayName({first='Bob',last='Smith'}: {first?: string; last?: string}={}){
    var name = first + " " + last;
    alert(name);
}

sayName();

Answer 3

不用解构，你可以创建一个默认参数并传入

interface Name {
   firstName: string;
   lastName: string;
}

export const defaultName extends Omit<Name, 'firstName'> {
    lastName: 'Smith'
}

sayName({ ...defaultName, firstName: 'Bob' })

Answer 4

这里有一些东西可以尝试，使用接口和使用默认值解构。请注意，“姓氏”是可选的。

interface IName {
  firstName: string
  lastName?: string
}

function sayName(params: IName) {
  const { firstName, lastName = "Smith" } = params
  const fullName = `${firstName} ${lastName}`

  console.log("FullName-> ", fullName)
}

sayName({ firstName: "Bob" })

Answer 5

Typescript 现在支持默认参数：

https://www.typescriptlang.org/docs/handbook/functions.html

另外，添加默认值可以省略类型声明，因为可以从默认值推断：

function sayName(firstName: string, lastName = "Smith") {
  const name = firstName + ' ' + lastName;
  alert(name);
}

sayName('Bob');

Answer 6

这可能是一个不错的方法，不需要长构造函数

class Person {
    firstName?: string = 'Bob';
    lastName?: string = 'Smith';

    // Pass in this class as the required params
    constructor(params: Person) {
        // object.assign will overwrite defaults if params exist
        Object.assign(this, params)
    }
}

// you can still use the typing 
function sayName(params: Person){ 
    let name = params.firstName + params.lastName
    alert(name)
}

// you do have to call new but for my use case this felt better
sayName(new Person({firstName: 'Gordon'}))
sayName(new Person({lastName: 'Thomas'}))

Answer 7

不，TypeScript 没有一种自然的方式来为定义的对象的属性设置默认值，就像一个有默认值而另一个没有。您可以定义更丰富的结构：

class Name {
    constructor(public first : string, 
        public last: string = "Smith") {

    }
}

并使用它来代替内联类型定义。

function sayName(name: Name) {
    alert(name.first + " " + name.last);
}

不幸的是，你不能这样做：

function sayName(name : { first: string; last?:string } 
       /* and then assign a default object matching the signature */  
       = { first: null, last: 'Smith' }) {

} 

因为它只会在 name 是 undefined 时设置默认值。