skip to content

docs / Engines

Engines

Choose how to build an engine for a UI platform, in TypeScript or any other language.

An engine drives a user interface, such as a browser, a simulator, or a TV, for screen, app, and the agent. The runner drives every engine over the engine protocol: JSON-RPC messages, one per engine member. @e2e-dev/web and @e2e-dev/mobile are engines too.

mermaid
  • e2e runner → transport: engine protocol
  • transport → defineEngine: web, mobile, yours: in process
  • transport → serveEngine, or a server in any language: child process
  • transport → a server on another machine or device: socket

Choose how to write one

You wantWriteGuide
An engine in TypeScriptdefineEngine, set on a targetWriting an engine
A TypeScript engine in its own processdefineEngine, served with serveEngineEngine servers
An engine in another language, or on a deviceA server that answers the protocol’s messagesEngine servers

An engine from defineEngine runs in the runner’s process. Every call still crosses the protocol, so an engine that passes its suite needs nothing a server elsewhere couldn’t receive.

Next

was this page helpful?