Interface: EngineConfig
ghostly-engine.EngineConfig
Ghostly Engine configuration.
Hierarchy
↳
EngineConfig
Properties
browser
• browser: "chromium" | "firefox" | "webkit"
What browser to use for rendering. Defaults to 'chromium'.
Defined in
ghostly-engine/src/engine.ts:28
browserPath
• browserPath: null | string
Override browser executable path.
Defined in
ghostly-engine/src/engine.ts:31
locale
• locale: string
Override the default browser locale. Defaults to system locale or en-US.
Defined in
ghostly-engine/src/engine.ts:34
logger
• logger: Console
A Console to use for debug logging.
Inherited from
Defined in
ghostly-engine/src/engine.ts:13
pageCache
• pageCache: number
If specified, the maximum number of cached templates to keep.
Defined in
ghostly-engine/src/engine.ts:37
pageMaxAge
• pageMaxAge: number
Number of seconds to keep cached template around. Defaults to 60 seconds.
Defined in
ghostly-engine/src/engine.ts:40
relaunchDelay
• relaunchDelay: number
A delay (in seconds) to wait before attempting to restart a crashed browser. Defaults to 1 s.
Defined in
ghostly-engine/src/engine.ts:43
templatePattern
• templatePattern: RegExp
A regular expression that all template network requests must match, or else they will be forbidden.
Inherited from
TemplateConfig.templatePattern
Defined in
ghostly-engine/src/engine.ts:16
timeZone
• timeZone: string
Override the default browser time zone. Defaults to system time zone or UTC.
Defined in
ghostly-engine/src/engine.ts:46
timeout
• timeout: number
Timeout while waiting for a command response from the template. Defaults to 10 s.
NOTE: Any call by the template to ghostly.notify will reset the watchdog and start counting from 0 again!
Inherited from
Defined in
ghostly-engine/src/engine.ts:22
workers
• workers: number
The number of browser instances to launch. Defaults to 1.