A readable stream the yields up log messages from the program.

Example:

const helloWorld = await createWorker("./helloWorld.ts");
// Use an async IIFE to avoid blocking the main loop
(async () => {
  for await (const msg of helloWorld.logs) {
    console.log(`[${helloWorld.name}] ${msg}`);
  }
})();
await helloWorld.listen({ port: 8000 });

The name of the worker.

A promise that resolves when the worker is initialized and ready.

The current state of the worker.

Type check the program as if it were a Deploy script, resolving with an array of diagnostic information. If the array is empty, there were no issues with type checking.

Close and terminate the worker. The worker will resolve when any pending requests are settled.

Send a request into the program and resolve with the resulting Response and additional information about the request.

For example:

const helloWorld = await createWorker("./hello_world.ts");
await helloWorld.run(async () => {
  const [response, info] = await helloWorld.fetch("/");
  // make assertions against the response
});

Diagnostic information about the current worker.

Start listening for requests, passing them to the worker and sending the responses back to the client.

Example:

const helloWorld = await createWorker("./helloWorld.ts");
await helloWorld.listen({ port: 8000 });

Start server and execute the callback. Once the callback finishes, the worker will be closed. Run resolves or rejects with the value returned from the callback. The callback will be called with the context of the worker.

This is useful when you need to run a set of assertions against the worker where the assertions might throw, but want to ensure the worker gets closed irrespective of if the callback throws or not.

Example:

const helloWorld = await createWorker("./helloWorld.ts");
await helloWorld.run(async function () {
  const [response, info] = await this.fetch("/");
  // make assertions against the response
});

Start the program, allowing it to take requests.

Stop the program, preventing it from taking new requests. The program can be restarted.