Бесплатный курс по TypeScript. Зарегистрируйтесь для отслеживания прогресса →

TypeScript: Перегрузка функций (Function Overloads)

Перегрузка функций - возможность определить несколько версий одной функции, каждая из которых принимает свой собственный набор параметров. Разберем на примере:

function concat(a: number, b: number): string;
function concat(a: string, b: string): string;

function concat(a: any, b: any): string {
  } else {
    return `${a.toFixed()}{b.toFixed()}`
  }
}

concat('one', 'two'); // onetwo
concat(3, 5.34); // 35
concat(1.33, 10); // 110

Здесь определяется одна функция concat(), у которой две версии, одна принимает на вход два числа, другая две строки. Обе версии выполняют конкатенацию, но делают это по разному. Строки конкатенируются сразу, а вот у чисел сначала отбрасывается дробная часть.

Реализация поведения для обеих версий делается в третьей функции с тем же именем, но с таким описанием параметров, которое подойдет под каждую версию функции. В примере выше типы параметров определены как any, что дает возможность вызывать функцию как со строками, так и с числами.

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

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

function add(a: number, b: number, c: number): number;
function add(a: number, b: number): any;
function add(a: string, b: string): any;

// Сигнатура подходит под все примеры выше
function add(a: any, b: any, c?: any): any {
  // тут вся логика
  if (c === undefined) {
    // ...
  }
}

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

// Пример на Kotlin
fun sayHello (name:String) = println("Hi ${name}")
fun sayHello (firstName:String, lastName:String) {
  return println("Hello ${firstName} ${lastName}")
}

sayHello("John", "Doe") // Hello John Doe
sayHello("Elon") // Hi Elon

Возникает вопрос, зачем в TypeScript именно такая реализация и какие проблемы она решает? Это, как и многое другое в TypeScript, попытка учесть все возможные варианты написания кода на JavaScript и покрыть их типами для написания типобезопасного кода. В JavaScript не редко создают функции, которые принимают на вход совершенно разные типы данных в разных вариациях. Перегрузка функций, позволяет описать подобные функции в TypeScript, иначе пришлось бы использовать any и следить за типами самостоятельно.

Технически, после трансляции в JavaScript остается ровно одна функция, как раз та, что содержит тело

Перегрузка функций в TypeScript - механизм, который стоит использовать только тогда, когда нет другого выбора. В большинстве случаев вместо перегрузки используются объединянения или дженерики, о которых мы поговорим позже. Перегрузка нужна тогда, когда между параметрами есть зависимость, например если оба параметра строки, либо оба параметра числа.

Задание

Реализуйте функцию sayHello(), которая аналогична примеру на Kotlin из теории:

sayHello('John'); // Hi John
sayHello('Mila', 'Mala'); // Hello Mila Mala
Упражнение не проходит проверку — что делать? 😶

Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:

  • Обязательно приложите вывод тестов, без него практически невозможно понять что не так, даже если вы покажете свой код. Программисты плохо исполняют код в голове, но по полученной ошибке почти всегда понятно, куда смотреть.
В моей среде код работает, а здесь нет 🤨

Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.

Мой код отличается от решения учителя 🤔

Это нормально 🙆, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.

В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.

Прочитал урок — ничего не понятно 🙄

Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.

Кстати, вы тоже можете участвовать в улучшении курсов: внизу есть ссылка на исходный код уроков, который можно править прямо из браузера.

Полезное


Нашли ошибку? Есть что добавить? Пулреквесты приветствуются https://github.com/hexlet-basics
Если вы столкнулись с трудностями и не знаете, что делать, задайте вопрос в нашем большом и дружном сообществе