你如何在 TypeScript 中模拟名义打字？

Question

我的项目中有许多以数字为参数的函数；这个数字一半时间是数组的索引，另一半时间是光标位置（数组中两个条目之间的点）。这会导致混淆，即使使用命名约定也是如此。

我想强制以下函数采用预期的名义类型。

class Index extends Number {}
class CursorPosition extends Number {}

function getElement(i: Index) {}
function getRange(p1: CursorPosition, p2: CursorPosition) {}

const myIndex: Index = 6;
const myPosition: CursorPosition = 6;

getElement(1); // would like this to fail at compile time
getRange(2, 3); // would like this to fail at compile time
getElement(myPosition); // would like this to fail at compile time
getRange(myIndex, myIndex); // would like this to fail at compile time

getElement(myIndex); // would like this to pass at compile time
getRange(myPosition, myPosition); // would like this to pass at compile time

我知道 typescript 使用结构化类型，这就是为什么这不会“开箱即用”发生。

另外，我考虑了对变量进行装箱和添加任意属性：

class myNum extends Number { 
  l: "1";
}

或使用演员表。

class myNum { 
  arb: "arbitrary property value";
}

const mn2: myNum = <any>8;

function getElement2(a: any[], i: myNum) {
  return a[<any>i];
}

getElement2([], mn2);
getElement2([], 6);

有更好的想法吗？

Answer 1

您可以使用品牌类型：

type Index =  Number & { __type: 'Index'}
type CursorPosition =  Number & { __type: 'CursorPosition'}


function getElement(i: Index) {}
function getRange(p1: CursorPosition, p2: CursorPosition) {}

function indexFromNumber(n: number) :Index {
    return n as any;
}

function cursorPositionFromNumber(n: number): CursorPosition {
    return n as any;
}

const myIndex: Index = indexFromNumber(6);
const myPosition: CursorPosition = cursorPositionFromNumber(6);

getElement(1); // error
getRange(2, 3);  // error
getElement(myPosition);  // error
getRange(myIndex, myIndex); // error

getElement(myIndex); // ok 
getRange(myPosition, myPosition); //ok 

您需要定义一个辅助函数来创建类型的实例或使用类型断言 (const myIndex = 1 as any as Index)，但如果您传递一个简单的数字，调用站点会出错。

article 对此主题进行了更多讨论。打字稿编译器也将这种方法用于paths