TypeScript中基于字符串内容的重载函数

Question

假设我有一个接受input 字符串参数的函数。如果input 以"!" 字符开头，则函数应返回boolean 类型。如果input 以"?" 字符开头，则函数应返回string[] 类型。

问题是，是否可以在 TypeScript 定义文件中记录此类行为的重载？

Answer 1

这是不可能的。

打字稿中的字符串可以是常量文字字符串，例如：

const a = "A"

或者它可能是string类型，这意味着它可能有任何内容，例如：

const str = prompt("What is your name?")`

无法定义匹配任何类型模式的字符串类型。

---

我不知道你想做什么，但这里可能有更好的方法来设计你的 API。

---

如果您确实知道所有可能性，则可以将它们视为常量字符串。

type Bang = "!A" | "!B" | "!C"
type Question = "?A" | "?B" | "?C"

function doStuff(str: Bang): boolean
function doStuff(str: Question): string[]

function doStuff(str: Bang | Question): boolean | string[] {
  if (str.startsWith("!")) {
    return true
  } else {
    return ['strings', 'here']
  }
}

doStuff('!A') // boolean
doStuff('?A') // string[]

Playground

---

Typescript 4.1 更新：

Typescript 4.1（2020 年 9 月 18 日刚刚发布测试版）包括对 Template Literal Types 的支持。这使您可以对字符串文字的内容进行强类型化。您现在可以提取部分字符串文字并单独使用它们。

有了这个功能，你的问题可以这样解决：

// Typescript 4.1
function doStuff<
  Prefix extends '!',
  Suffix extends string
>(str: `${Prefix}${Suffix}`): boolean

function doStuff<
  Prefix extends '?',
  Suffix extends string
>(str: `${Prefix}${Suffix}`): string[]

function doStuff<
  Prefix extends '!' | '?',
  Suffix extends string
>(str: `${Prefix}${Suffix}`): boolean | string[] {
  if (str.startsWith("!")) {
    return true
  } else {
    return ['strings', 'here']
  }
}

doStuff('!A') // boolean
doStuff('?A') // string[]
doStuff('bad format') // type error

4.1 Playground