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

Тип void и void в функциях

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

void означает, что функция не возвращает полезного значения: в runtime она вернет undefined, но вызывающий код не должен использовать результат. В отличие от undefined, void в типе колбэка разрешает передать функцию, которая что-то возвращает, — результат просто игнорируется. Для функций, которые никогда не завершаются, используется never.

Вопрос

Что означает тип void? Чем void отличается от undefined и never в функциях?

Базовое использование

function log(message: string): void {
  console.log(message);
}
 
const handleClick = (): void => {
  setOpen(true);
};

Обычно аннотация не нужна: TypeScript сам выведет void для функции без return.

void и undefined

function a(): void {}                 // OK
function b(): undefined { return; }    // нужен return (в TS 5.1+ можно без него)
 
const result = log("hi");             // тип void — использовать нельзя осмысленно
if (result) {}                        // ошибка: An expression of type 'void' cannot be tested for truthiness
voidundefined
Смысл«значение не используется»конкретное значение undefined
Как тип переменнойбессмысленнодопустимо
В типе колбэкаразрешает любые возвращаемые значениятребует именно undefined

void в типах колбэков

type Listener = () => void;
 
const numbers: number[] = [];
const push: Listener = () => numbers.push(1); // OK, хотя push возвращает number
 
[1, 2, 3].forEach((n) => numbers.push(n));   // OK — forEach ожидает колбэк с void

Это намеренное правило: колбэк, тип возврата которого void, может вернуть что угодно — значение будет проигнорировано. Иначе нельзя было бы передать arr.push в forEach.

Но если функция объявлена с : void, вернуть значение нельзя:

function save(): void {
  return 42; // ошибка
}

void, never и Promise

function notify(): void {}                       // завершается без значения
function crash(): never { throw new Error(); }   // не завершается
async function sync(): Promise<void> {           // асинхронная функция без значения
  await api.sync();
}

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

  • void в union (string | void) почти всегда ошибка проектирования — используйте undefined.
  • В JSX-обработчиках () => void позволяет писать onClick={() => setCount(c + 1)}, даже если сеттер что-то возвращает.
  • Оператор JavaScript void expr — другое понятие: он вычисляет выражение и возвращает undefined.
  • Правило @typescript-eslint/no-misused-promises предупреждает, если async-функцию передают туда, где ожидается () => void, — промис никто не обработает.

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

  • void — результат функции не используется.
  • В runtime — undefined.
  • В типе колбэка void разрешает любое возвращаемое значение.
  • never — функция не завершается.
  • Async без значения — Promise<void>.

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

TypeScript Handbook: void, TypeScript FAQ: Why are functions returning non-void assignable to function returning void?.

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

Поиск

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