问题情景:
最近为一个年代久远的库重写了typescript版本,(这个库能把html文本转化为docx文档),里面遇到最主要的就是options的处理,也就是函数参数选项处理,情景如下:
const data = await asBlob(htmlString, { orientation: 'landscape', margins: { top: 100 } })
这里的函数入口的主选项允许只提供部分参数,而且嵌套子选项的margins也需要允许只提供部分参数。
刚开始我使用函数的可选和默认参数进行设计,可是效果不理想,想不出如何推导类型。
处理方案:
后来我总结出了一套用Partial
和mergeOptions
合并选项,并且声明子选项默认值,用默认值构造子选项类型的方法。实现比较简单和优雅,当然如果你有更好的解决方案,欢迎提出评论意见!
首先,我个人倾向于在最里层的函数,也就是使用到这个参数的函数那里定义所需的数据类型。
比如margins是在 src/template/documentTemplates.ts
这里用到的,我们就在这个文件这里声明Margins类型或者接口。
同时,我建议选项类型,先定义默认参数,再用typeof
进行初始化:
// 声明margins的默认参数
export const defaultMargins = {
top: 1440,
right: 1440,
bottom: 1440,
left: 1440,
header: 720,
footer: 720,
gutter: 0,
}
// 通过参数声明margins类型
export type Margins = typeof defaultMargins
// 同文件函数直接引用这个类型
export const documentTemplate = (..., margins: Margins) => {}
但是,我们希望选项在入口函数的时候我们只需要填写部分参数即可,比如上面的margins,我们可能只是想要指定top参数,这该怎么处理呢?
这里我建议在入口函数的相关参数处使用Partial
部分类型。Partial
是typescript全局提供的工具类型,你只需要提供一个“完整类型”,它就能生成一个“部分类型”。
function asBlob(html: string, options: Partial<DocumentOptions> = {})
它的实现也十分简单:
type Partial<T> = {
[P in keyof T]?: T[P];
};
最后,我们在入口函数向参数使用函数传参处使用mergeOptions
合并参数就可以了:
function mergeOptions<T>(options: T, patch: Partial<T>) {
return { ...options, ...patch } as T
}
const marginsOptions = mergeOptions(defaultMargins, margins)
这一套方案可以消灭大多数的用嵌套对象做选项参数的情景啦。
字面量自动扩展(type widen)问题
在项目中,我需要用一个字符串字面量(String Literal Types)来做参数,在正常使用的时候没问题,比如:
function asBlob(html, {orientation: ''}) //编辑器会自动补全,并且类型正确推导
但是,当把选项声明为独立的Object
,再放进去的时候会提示TypeError
,显示oritentation应该是Orient类型,不应该是string类型。
import { asBlob } from 'html-docx-js-typescript'
const opt = {
margin: {
top: 100
},
orientation: 'landscape' // type error: because typescript automatically widen this type to 'string' but not 'Orient' - 'string literal type'
}
await asBlob(html, opt)
这是怎么回事?我明明声明的时候用的是字面量中的其中一个啊!
后来通过typescript issueSyntax for hinting literal type inference #10195了解到,这是字面量参数自动发生了类型扩展(type widening),因为你声明一个独立对象的时候,你不能保证这个字面量参数不会发生变化,因此typescript自动把它扩展为string
类型,导致类型错误!
这个时候我们应该让它避免类型扩展,你可以暴露Orient 类型,用类型断言来指定这个类型,也可以用const
把类型固定为常量。因为我不想暴露这个类型,让用户产生心智负担,所以我推荐直接用as const
。
const opt = {
margin: {
top: 100
},
orientation: 'landscape' as const
}
🤞如果有大佬提出更好的解决方案,可以评论区交流哈~