RuntimeInstance
Interface: RuntimeInstance
Defined in: index.ts:337
Публичный интерфейс экземпляра рантайма.
RootComponent— корневой React-компонент, который нужно монтировать в дерево (preview в builder-web, runtime-host SPA и т.п.).getSnapshot/subscribe— механизм наблюдения за состоянием рантайма (для подсветки нод, инспектора состояния и devtools).dispatch— типизированный канал внешних команд (navigate, программные изменения состояния, отладочные сценарии и т.п.).
Properties
RootComponent
RootComponent:
ComponentType
Defined in: index.ts:344
Корневой React-компонент, который рендерит приложение.
Его следует монтировать в нужное место UI-хоста (например, в панель превью builder-web).
Methods
dispatch()
dispatch(
command):void
Defined in: index.ts:375
Отправка команды в рантайм.
Детали обработки команд зависят от внутренней реализации. На ранних итерациях может поддерживаться только часть команд.
Parameters
command
команда, которую нужно выполнить
Returns
void
getSnapshot()
getSnapshot():
RuntimeSnapshot
Defined in: index.ts:354
Возвращает актуальный snapshot состояния рантайма.
Полезно:
- при первоначальной инициализации UI-инспекторов;
- в тестах;
- при ручной отладке.
Returns
subscribe()
subscribe(
listener): () =>void
Defined in: index.ts:365
Подписка на изменение snapshot’а.
Листенер вызывается каждый раз, когда рантайм обновляет внутреннее состояние и формирует новый snapshot.
Parameters
listener
(snapshot, reason) => void
коллбек, получающий новый snapshot и причину изменения
Returns
функция отписки
():
void
Returns
void