Как правильно сформировать объект-результат в перегруженной функции в TypeScript?

Question

[johnymkp]

Разбираю раздел про перегрузку функций в ТС. Вроде суть понял, что на все перегрузки должна быть одна комбинированная реализация, которая учитывает все особенности вызова. Однако не понимаю, как правильно собрать итоговый объект. Вот сделал пример. Работает, но смущает вот что:
1. Я использовал any для объекта, а значит в него кроме нужных свойств можно накидать произвольных.
2. Если переписать как-то так

Рефакторинг

function reserve(from: Date, toOrDest: Date | string, destination?: string): Ticket {
  if (toOrDest instanceof Date && destination !== undefined) {
    return { 
      type: "two-way",
      from,
      to: toOrDest,
      destination
    }
  } else if (typeof toOrDest === 'string') {
    return { 
      type: "one-way",
      from,
      destination: toOrDest
    }
  } 
  throw new Error("Некорректный вызов функции резервирования билета");
}

тогда, во-первых, появляется дублирование кода (свойство from приходится писать в обоих ветках отдельно, хотя оно во всех случаях гарантированно присутствует), а, во-вторых, приходится писать выброс ошибки, что выглядит некрасиво и к тому же в принципе как будто не может случиться, т.е. получается строчка чисто чтобы компилятор не ругался.

Покажите, как сделать канонично с точки зрения программирования на TS?

Comments

[Lynn «Кофеман»]

А точно надо проверять на instanceOf Date?

[WbICHA]

т.е. получается строчка чисто чтобы компилятор не ругался.

Да ну? А что будет, если у нас будет дата, но не будет дестинейшн?

[Aetae]

Переписанный вариант абсолютно нормальный. Про "дублирование" from даже на думай:
1. такой вариант даже менее многословен чем первый, из-за отсутствия обращения к объекту, если вопрос в этом;
2. он создаст все равно только один объект, в зависимости от if ветки;
3. он быстрее будет работать на v8(добавление свойств в объект, которых изначально не было там затратное) - но это только на случай миллионов вызовов.

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

P.S. Если вместо хипстерской стрелки использовать нормальную функцию, то можно перегрузки писать так:

function reserve(from: Date, destination: string): Ticket; 
function reserve(from: Date, to: Date, destination: string): Ticket;
function reserve(from: Date, toOrDest: Date | string, destination?: string): Ticket {

что на мой взгляд куда нагляднее и удобнее.

Answer 1

[Alexandroppolus]

type Reserve = {
  (from: Date, to: Date, destination: string): Ticket;
  (from: Date, destination: string): Ticket
};
  
const reserve: Reserve = (from: Date, ...args: [toOrDest: Date, destination: string] | [destination: string]): Ticket => {
  const isOne = args.length === 1;

  return {
    type: isOne ? "one-way" : "two-way",
    from,
    destination: isOne ? args[0] : args[1],
    ...(isOne ? {} : {to: args[0]})
  };
};

На самом деле, такая запись уже даёт перегрузку функции, даже если отсюда вообще выкинуть тип Reserve. Но тогда при наведении мыши на reserve будет не совсем понятная подсказка (хотя автокомплит вполне корректный).

Ну а для данного примера лучше всего просто передвинуть параметр destination на нулевую позицию, тогда у тебя будет просто необязательный параметр в конце списка

Comments

[johnymkp]

Alexandroppolus Решение определенно интересное, но выглядит слишком технически привязанным к таким вещам как последовательность параметров, их количество. В общем несколько хрупковато как будто. Перемещение параметра было бы удобно, но в целях обучения хотелось бы оставить его на месте пока что.
P.S. Я конечно понимаю, что если что-то изменится, то на то она и строгая типизация, чтобы все сразу ломалось как можно быстрее, но есть ли еще какие-нибудь варианты решения? Просто для сравнения хотя бы.

[Alexandroppolus]

johnymkp, да вариантов особенно нет, можно делать как у тебя, только для объекта-результата задать типизацию и накидать туда заглушек, чтобы не ругалось:

const reserve: Reserve = (from: Date, toOrDest: Date | string, destination?: string): Ticket => {
  const ticket: Ticket = {
     from, 
     type: "one-way",
     destination: "",
  };
  
  if (toOrDest instanceof Date && destination !== undefined) {
    ticket.type = "two-way";
    ticket.to = toOrDest;
    ticket.destination = destination;
  } else if (typeof toOrDest === 'string') {
    ticket.destination = toOrDest;
  }

  return ticket;
}

необязательные параметры в середине списка, с возможным "сдвигом" - это всегда мини-костыли в коде.

[WbICHA]

johnymkp,

выглядит слишком технически привязанным к таким вещам как последовательность параметров, их количество

Эммм, так в жс у всех функций такая привязка.

[WbICHA]

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

[WbICHA]

johnymkp, как вариант, можно ещё в функцию дополнительно обернуть:

const reserve = (from: Date, to?: Date) => (destination: string) => { ... }