打字稿:强制类型为“字符串文字”而不是 <string>

Aid*_*din 7 string branding literals typescript

问题

打字稿中有没有办法定义一个类型,它只是一个字符串文字,不包括string它自己?

请注意,我不是在谈论某个字符串文字列表;为此, 的简单联合"Value1" | "Value2"enum类型将起作用。我说的是任何字符串文字,但不是string它本身。

示例代码

type OnlyStringLiterals = ...; // <--- what should we put here?

const v1: OnlyStringLiterals = "hi"; // should work
const v2: OnlyStringLiterals = "bye"; // should work
// and so should be for any single string value assigned

// But:
const v3: OnlyStringLiterals = ("red" as string); // should NOT work -- it's string
Run Code Online (Sandbox Code Playgroud)

用例

我正在对代码中的类型进行品牌化,并将品牌名称作为模板传递给我的父类。请参阅下面的代码:

abstract class MyAbstractClass<
    BRAND_T extends string,
    VALUE_T = string
> {
    constructor(private readonly _value: VALUE_T) { }

    getValue(): VALUE_T { return this._value; }

    private _Brand?: BRAND_T; // required to error on the last line, as intended!
}

class FirstName extends MyAbstractClass<"FirstName"> {
}

class AdminRole extends MyAbstractClass<"AdminRole"> {
}

class SubClassWithMissedName extends MyAbstractClass<string> {
   // I want this to error! ........................ ^^^^^^
}

function printName(name: FirstName) {
    console.log(name.getValue()); 
}

const userFirstName = new FirstName("Alex");
const userRole = new AdminRole("Moderator");

printName(userRole); // Already errors, as expected
Run Code Online (Sandbox Code Playgroud)

游乐场链接

我想确保每个子类都准确地传递一个字符串文字,而不仅仅是string传递给父类。

Aid*_*din 5

我找到了一个适用于我的用例的答案,但不是最可重用的。还是分享一下吧。

思考过程

我相信不可能用一种实体类型来表示我想要的东西,因为我什至无法想象如果我将鼠标悬停在 VS Code 上会出现什么!

但是,据我所知,Typescript 中有一个函数样式检查类型,您可以传入一个类型并期望返回一个类型,最后为其分配一个值以查看它是否通过。

使用通用类型和后续分配进行类型检查

使用这种技术,我正在考虑以下模板类型:

type TrueStringLiterals<T extends string> = string extends T ? never : true;

const v1 = "hi";
const check1: TrueStringLiterals<typeof v1> = true; // No error :-)

const v2 = "bye";
const check2: TrueStringLiterals<typeof v2> = true; // No error :-)

const v3 = ("red" as string);
const check3: TrueStringLiterals<typeof v3> = true; // Errors, as expected!
Run Code Online (Sandbox Code Playgroud)

游乐场链接

在已经通过的泛型类型中更容易

另外,在我的用例中,我正在做:

abstract class MyAbstractClass<
    BRAND_T extends (string extends BRAND_T ? never : string),
    VALUE_T = string
> {
...
Run Code Online (Sandbox Code Playgroud)

游乐场链接

...这就像一个魅力!


Mac*_*ora 5

您可以创建仅允许字符串子集的实用程序类型:

type SubString<T> = T extends string ?
    string extends T ? never
    : T
    : never

const makeSubStr = <T extends string>(a: SubString<T>) => a
const a = makeSubStr('strLiteral')
const b = makeSubStr('strLiteral' as string) // error

const c: string = 'elo I am string'
const d = makeSubStr(c) // error

const e: SubString<"red"> = ("red" as string); // error
Run Code Online (Sandbox Code Playgroud)

never如果某些内容不是字符串,此类型也会返回,在您的答案中TrueStringLiterals不会考虑这种情况并传递它。