Typescript | 浅谈对于选项options的处理方案

问题情景:

最近为一个年代久远的库重写了typescript版本,(这个库能把html文本转化为docx文档),里面遇到最主要的就是options的处理,也就是函数参数选项处理,情景如下:

const data = await asBlob(htmlString, { orientation: 'landscape', margins: { top: 100 } })

这里的函数入口的主选项允许只提供部分参数,而且嵌套子选项的margins也需要允许只提供部分参数
刚开始我使用函数的可选和默认参数进行设计,可是效果不理想,想不出如何推导类型。

处理方案:

后来我总结出了一套用PartialmergeOptions合并选项,并且声明子选项默认值,用默认值构造子选项类型的方法。实现比较简单和优雅,当然如果你有更好的解决方案,欢迎提出评论意见!

首先,我个人倾向于在最里层的函数,也就是使用到这个参数的函数那里定义所需的数据类型。
比如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
}

🤞如果有大佬提出更好的解决方案,可以评论区交流哈~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,761评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,953评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,998评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,248评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,130评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,145评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,550评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,236评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,510评论 1 291
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,601评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,376评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,247评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,613评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,911评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,191评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,532评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,739评论 2 335

推荐阅读更多精彩内容