在Typescript函数中可以有可选的非结构化参数吗？

Question

我想编写一个函数，它接受一个对象参数，在函数签名中使用解构，并且该参数是可选的：

myFunction({opt1, opt2}?: {opt1?: boolean, opt2?: boolean})

但是，TypeScript不允许我（绑定模式参数在实现签名中不能是可选的。）。

如果我不破坏结构，我当然可以做到：

myFunction(options?: {opt1?: boolean, opt2?: boolean}) {
  const opt1 = options.opt1;
  const opt2 = options.opt1;
  ...

看起来这些应该是一样的，但是上面的例子是不允许的。

我想使用一个去结构化的语法（1）因为它存在，并且是一个很好的语法，并且上面的两个函数应该表现相同似乎是很自然的，并且（2）因为我还想要一个简洁的方法来指定默认值：

myFunction({opt1, opt2 = true}?: {opt1?: boolean, opt2?: boolean})

在不进行分解的情况下，我必须在函数的实现中隐藏这些默认值，或者有一个参数，它实际上是一个具有构造函数的类。。。

Answer 1

这是最好的方法，如果你想混合可选和必需的参数，但有一个导出类型，其中所有的值都是必需的/非空：

export function newCar(args: {
    year?: number
    make?: string
    model: string
    owner: [string, string]
}) {
    const defaults = {
        year: 1999,
        make: "toyota",
    }
    return { ...defaults, ...args }
    // to get a Readonly<Car>:
    // return Object.freeze(args)
}

export type Car = ReturnType<typeof newCar>

const c = newCar({ model: "corolla", owner: ["Gorg", "Blafson"] })

export function print(c: Car) {
    console.log(`${c.owner}'s gorgeous ${c.year} ${c.model} from ${c.make}`)
}

Answer 2

如果没有作为参数给定的对象，则无法分解结构。因此，在parmas中使用一个默认对象，如前一篇文章所述：

type Options = { opt1?: boolean; opt2?: boolean; }

function myFunction({ opt1, opt2 }: Options = {}) {
    console.log(opt2, opt1);
}

myFunction() // undefined,  undefined 
myFunction({opt1: false}); // undefined,  false 
myFunction({opt2: true}); // true,  undefined

我想补充的是，当以下两个条件成立时，参数中的析构模式增加了最多的值：

• 期权数量可能会发生变化
• 函数的API可能会发生更改。i、 e.功能参数可能会发生变化

基本上，析构化使您更具灵活性，因为您可以添加任意多的选项，只需对函数的API进行最小的更改。

但是，更基本的版本会更简单：

// If the function is not likely to change often just keep it basic:
function myFunctionBasic( opt1? :boolean, opt2?: boolean ) {
    console.log(opt2, opt1);
}

Answer 3

请改用默认参数：

function myFunction({ opt1, opt2 = true }: { opt1?: boolean; opt2?: boolean; } = {}) {
    console.log(opt2);
}

myFunction(); // outputs: true

这是必要的，为了不破坏结构未定义的：

function myFunction({ opt1, opt2 }) {
}
    
// Uncaught TypeError: Cannot destructure property `opt1` of 'undefined' or 'null'.
myFunction();