省略参数意味着什么:可选性与参数元组

区分回调少声明参数、参数可省略和 undefined,再用两层默认值设计配置对象 API。

本章目录CONTENTS ↓

分页调用允许省略整个配置,也允许传空对象,还允许只写 page。它们看起来都是“少传一点”,但省略的位置不同:参数列表缺一项与对象缺一个属性,并不是同一件事。

本章把这些调用许可准确写成类型,再观察 Parameters 怎样保留它们。默认值只用来说明静态许可与实际补值的区别;分页算法和配置策略不是本章的学习目标。

完整案例:允许部分配置的分页函数

先列允许的调用:零个参数、一个空对象、一个部分配置对象。对象中的问号负责属性缺省;整个参数还要独立允许省略。若只有属性问号,空参数列表仍不合法。

type PageOptions = { page?: number; pageSize?: number };
function getOffset({ page = 1, pageSize = 20 }: PageOptions = {}): number {
return (page - 1) * pageSize;
}
getOffset(); // 0
getOffset({}); // 0
getOffset({ page: 3 }); // 40
getOffset({ page: 3, pageSize: 10 }); // 20

调用不传配置时,外层默认值先提供 {};解构再为缺失的字段补值。调用传入部分配置时,只补对应的缺失字段。默认值处理 undefined,不会把 0、空字符串等假值当作缺失;null 也不会触发默认值。

声明位置 负责的约定
page?: number 对象可以缺少 page 属性。
参数末尾 = {} 整个参数省略或为 undefined 时提供空对象。
解构中 page = 1 属性值为 undefined 时补为 1。

这里假定数字已符合业务范围;number 不能证明页码是正整数。若值来自外部输入,还需要运行时校验。

省略许可不会跨层传播

function getPageSize({ pageSize = 20 }: PageOptions) {
return pageSize;
}
getPageSize({}); // 20
// @ts-expect-error 属性可以缺少,整个参数仍是必填
getPageSize();
type RequiredOptions = { size: number };
function requiredSize({ size = 20 }: RequiredOptions) { return size; }
// @ts-expect-error 运行时默认值不会改写 size 的必填声明
requiredSize({});

同理,x?: number 允许省略参数;x: number | undefined 要求这个普通参数位置仍然被提供,只是值可以为 undefined。二者在函数体里都可能得到 undefined。

function optional(x?: number) { return x; }
function required(x: number | undefined) { return x; }
optional();
optional(undefined);
required(undefined);
// @ts-expect-error 允许 undefined 不等于允许省略
required();

这些例子使用严格模式。可选属性能否显式写 undefined,还与 exactOptionalPropertyTypes 有关;需要时查该选项,不把属性赋值规则与可选参数规则混为一谈。

回调:实现不用参数,不等于调用方可以省略

function visit(items: string[], callback: (value: string, index: number) => void) {
items.forEach((value, index) => callback(value, index));
}
visit(["a", "b"], value => console.log(value));
visit(["a", "b"], (value, index) => console.log(value, index.toFixed()));
// @ts-expect-error visit 只保证提供两个参数
visit(["a"], (value: string, index: number, all: string[]) => console.log(all[index]));

visit 仍然每次传两个实参,回调可以忽略不用的尾部参数。因此无需为了允许简短回调而把 index 改成可选。

若签名是 (value: string, index?: number) => void,它允许调用方省略下标;实现就必须接得住 undefined。严格检查下,仅接受必填 number 下标的实现不能满足它。

const flexible = (value: string, index?: number) => {
console.log(index !== undefined ? `${value}: ${index.toFixed()}` : "无下标");
};
const handler: (value: string, index: number) => void = flexible;
handler("a", 0);
// @ts-expect-error 调用按 handler 的签名检查
handler("a");

赋值检查实现能否满足契约;调用检查当前签名要求什么。index !== undefined 保留下标 0,也将真分支中的 index 收窄为 number。

参数列表是另一层结构

type OffsetArgs = Parameters<typeof getOffset>; // 等价于 [PageOptions?]
const noArgs: OffsetArgs = [];
const configured: OffsetArgs = [{ page: 3 }];

函数只有一个对象参数,两个配置属性不是两个参数位置。这个可选元组可以用于函数包装透传调用,而不用重复实现默认值。

查阅入口:Optional Parameters、Optional Parameters in Callbacks、Optional Properties、exactOptionalPropertyTypes。回到全景。

这一页,先记到这里。