Перейти к основному содержимому
Версия: Next

Type Alias: EditorEventCallback<Event>

EditorEventCallback<Event> = Event extends keyof EditorEvents ? (payload) => Promise<void> | void : never

Тип для обработчика события редактора с типобезопасностью.

Гарантирует что обработчик получит правильный тип параметра в зависимости от типа события.

Type Parameters

Event

Event

Ключ события из EditorEvents

Remarks

Автоматическая типизация:

  • При подписке на 'documentChange' обработчик получит DocumentChangeEventPayload
  • При подписке на 'editorError' обработчик получит ErrorEventPayload
  • IDE предоставит автодополнение свойств параметра
  • Компилятор проверит типы и предупредит об ошибках

Возвращаемое значение:

  • Синхронная функция: void
  • Асинхронная функция: Promise<void>

Example

// Обработчик с автоматической типизацией
const handler: EditorEventCallback<'documentChange'> = (payload) => {
// payload имеет тип DocumentChangeEventPayload
console.log(payload);
};

// Асинхронный обработчик
const asyncHandler: EditorEventCallback<'editorError'> = async (payload) => {
// payload имеет тип ErrorEventPayload
await reportError(payload);
};

See

EditorEvents — сопоставление событий и типов