Блог

Я хотел использовать функцию перегрузки TypeScript для создания функции, которая возвращает разные типы на основе переданных аргументов. Мне удается заставить ее работать, но компилятор не может перехватить ошибку внутри реализации перегруженной функции.

Приведенный ниже пример взят из документации по TypeScript (см. Ниже). Функция принимает два разных типа в качестве своих аргументов:

• object : ожидайте возврата типа number
• number : ожидайте возврата типа object

 // With incompatible types

const suits = ["hearts", "spades", "clubs", "diamonds"];

function pickCard(x: { suit: string; card: number }[]): number;
function pickCard(x: number): { suit: string; card: number };
function pickCard(x): any {
  if (typeof x == "object") {
    let pickedCard = Math.floor(Math.random() * x.length);
    // This part does not match the overload definition. The signature
    // expect a `number` but we provide a `string`. The compiler does
    // not throw an error in that case.
    return pickedCard.toString();
  } else if (typeof x == "number") {
    let pickedSuit = Math.floor(x / 13);
    return { suit: suits[pickedSuit], card: x % 13 };
  }
}

const card = pickCard([{ suit: 'hearts', card: 5 }])

card.toFixed() // throw a runtime error: card.toFixed is not a function
  

 // With compatible types

type Hand = { suit: string; card: number };

type HandWithScore = Hand amp; { score: number }

const suits = ["hearts", "spades", "clubs", "diamonds"];

function pickCard(x: Hand[]): HandWithScore;
function pickCard(x: number): Hand;
function pickCard(x): HandWithScore | Hand {
  if (typeof x == "object") {
    let pickedCard = Math.floor(Math.random() * x.length);
    // This part does not match the overload definition.
    return { suit: 'hearts', card: x % 13 };
  } else if (typeof x == "number") {
    let pickedSuit = Math.floor(x / 13);
    return { suit: suits[pickedSuit], card: x % 13 };
  }
}

const card = pickCard([{ suit: 'hearts', card: 5 }])

card.score.toFixed() // throw a runtime
  

Реализация не соответствует определению перегрузки, и компилятор не предупреждает нас в этом случае, что означает, что у нас может возникнуть проблема во время выполнения, поскольку мы ожидаем number , но на самом деле получаем string . Ожидается ли, что компилятор не выдает?

Вы можете протестировать образец внутри TypeScript playground.

Компилятор TypeScript не может проанализировать логику кода, чтобы убедиться, что он соответствует контракту. Я удивлен, увидев, что он не может уловить тот факт, что вы возвращаете строку из функции, которая должна возвращать либо число, либо объект, но возможность сделать это вполне может быть в списке «Сделать» (там много дел) и просто еще не дошла туда. Я склонен думать, что это было бы довольно низким приоритетом, поскольку в любом случае это не может гарантировать корректность, поскольку оно не может анализировать логический поток.

Если вы определяете тип для своих карточек, вы можете указать number | Card вместо any для реализации:

 const suits = ["hearts", "spades", "clubs", "diamonds"];
type Card = { suit: string; card: number; };

function pickCard(x: Card[]): number;
function pickCard(x: number): Card;
function pickCard(x): number | Card {
  if (typeof x == "object") {
    const cards = x as Card[];
    let pickedCard = Math.floor(Math.random() * cards.length);
    return pickedCard.toString();  // <========================== Compilation error
  } else if (typeof x == "number") {
    const n = x as number;
    let pickedSuit = Math.floor(n / 13);
    return { suit: suits[pickedSuit], card: x % 13 };
  }
}

const card = pickCard([{ suit: 'hearts', card: 5 }])

card.toFixed()
  

На игровой площадке.

Это не может помочь вам в случаях, когда вы не выполняете ветвление должным образом, но это может помочь вам в этой ситуации, когда вы возвращаете строку из функции, которая должна возвращать число или карточку.

(Возможно, вы могли бы заставить это работать без определения типа, но я не смог сразу это сделать, и в любом случае весь этот повторный ввод кажется проблематичным.)

Если реализация нетривиальна, вы могли бы даже объединить это с моим предыдущим предложением о разделении реализаций на их собственные типобезопасные функции:

 const suits = ["hearts", "spades", "clubs", "diamonds"];
type Card = { suit: string; card: number; };

function pickCard(x: Card[]): number;
function pickCard(x: number): Card;
function pickCard(x): number | Card {
  if (typeof x == "object") {
    return pickCard_Cards(x as Card[]);
  } else if (typeof x == "number") {
    return pickCard_number(x as number);
  }
}
// These wouldn't be exported
function pickCard_Cards(cards: Card[]): number {
    let pickedCard = Math.floor(Math.random() * cards.length);
    return pickedCard.toString();  // <========================== Compilation error
}
function pickCard_number(n: number): Card {
    let pickedSuit = Math.floor(n / 13);
    return { suit: suits[pickedSuit], card: x % 13 };
}

const card = pickCard([{ suit: 'hearts', card: 5 }])

card.toFixed()
  

<a rel="noreferrer noopener nofollow" href="https://www.typescriptlang.org/play/index.html#src=const suits = ["hearts", "spades", "clubs", "diamonds"];
type Card = { suit: string; card: number; };

function pickCard(x: Card[]): number;
function pickCard(x: number): Card;
function pickCard(x): number | Card {
if (typeof x == "object") {
return pickCard_Cards(x as Card[]);
} else if (typeof x == "number") {
return pickCard_number(x as number);
}
}
// These wouldn't be exported
function pickCard_Cards(cards: Card[]): number {
let pickedCard = Math.floor(Math.random() * cards.length);
return pickedCard.toString(); // На игровой площадке

…так что логика каждой ветви проверяется индивидуально (вы случайно не возвращаете a Card[] из ветви, которая должна возвращать a number , и наоборот).