Skip to content

@pumpkin-plugins/test-harness API / instance / startPumpkin

Variable: startPumpkin ​

const startPumpkin: (options) => Promise<PumpkinInstance> = PumpkinInstance.start

Defined in: instance.ts:176

Starts a Pumpkin server. Shorthand for PumpkinInstance.start.

Starts a server and waits until it is running.

Parameters ​

options? ​

StartOptions = {}

What to put in its directory and how to name its log.

Returns ​

Promise<PumpkinInstance>

The running server.

Throws ​

When it doesn't start in time, or keeps losing its port to another process. The server is stopped first.

Pumpkin Plugins documentation