re:re:actable
Урок 022 минуты чтения

Необязательные параметры, значения по умолчанию и rest-параметры

На этой странице
Кратко

Необязательный параметр помечают ? (title?: string), и его тип становится T | undefined. Параметр со значением по умолчанию (size = 10) тоже необязателен, а его тип выводится из значения. Переменное число аргументов описывают rest-параметром с типом массива или кортежа: ...ids: number[]. Обязательные параметры идут первыми, rest — последним.

Вопрос

Как задать параметр по умолчанию и необязательный параметр в TypeScript? Как типизировать функцию с переменным числом аргументов?

Необязательные параметры

function greet(name: string, greeting?: string) {
  return `${greeting ?? "Привет"}, ${name}`;
}
 
greet("Анна");           // OK
greet("Анна", "Хай");    // OK

Необязательный параметр не может стоять перед обязательным:

function wrong(a?: string, b: string) {} // ошибка

Значения по умолчанию

function paginate(items: string[], page = 1, size = 20) {
  // page: number, size: number — выведено из значений
  return items.slice((page - 1) * size, page * size);
}
 
paginate(list);
paginate(list, 2);
paginate(list, undefined, 50); // undefined включает значение по умолчанию

Параметр по умолчанию можно ставить и в середине — тогда для пропуска передают undefined. Значение по умолчанию срабатывает только для undefined, но не для null.

Объект настроек с дефолтами

type Options = {
  retries?: number;
  timeout?: number;
};
 
function request(url: string, { retries = 3, timeout = 5000 }: Options = {}) {}
 
request("/api");
request("/api", { timeout: 1000 });

Rest-параметры

function sum(...numbers: number[]): number {
  return numbers.reduce((a, b) => a + b, 0);
}
 
sum(1, 2, 3);
 
function log(level: "info" | "error", ...messages: unknown[]) {}
 
// кортеж в rest — точное число и типы аргументов
function setPosition(...args: [x: number, y: number]) {}
setPosition(10, 20);
setPosition(10);      // ошибка

Кортежи с именованными элементами ([x: number, y: number]) улучшают подсказки IDE.

Spread аргументов

const point = [10, 20] as const;
setPosition(...point);          // OK — кортеж нужной длины
 
const nums = [1, 2];
Math.max(...nums);              // OK для rest-параметров
setPosition(...nums);           // ошибка: number[] может быть любой длины

Что важно помнить

  • name?: string и name: string | undefined различаются: во втором случае аргумент нужно передать явно.
  • Для 3+ необязательных параметров удобнее объект настроек — порядок не важен.
  • Параметры с дефолтами и rest не учитываются в fn.length в runtime.
  • Тип Parameters<typeof fn> возвращает кортеж параметров — удобно для оберток.

Мини-шпаргалка

  • param?: T — необязательный, тип T | undefined.
  • param = value — необязательный с дефолтом, тип выводится.
  • Обязательные — первыми, rest — последним.
  • ...args: T[] или кортеж ...args: [a: T, b: U].
  • Дефолт срабатывает только на undefined.

Документация

TypeScript Handbook: Optional Parameters, TypeScript Handbook: Rest Parameters.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам