Interface BrowserServer

interface BrowserServer {
    [asyncDispose](): Promise<void>;
    addListener(event, listener): this;
    close(): Promise<void>;
    kill(): Promise<void>;
    off(event, listener): this;
    on(event, listener): this;
    once(event, listener): this;
    prependListener(event, listener): this;
    process(): ChildProcess;
    removeListener(event, listener): this;
    wsEndpoint(): string;
}

Methods

[asyncDispose] addListener close kill off on once prependListener process removeListener wsEndpoint

Methods

[asyncDispose]

  • [asyncDispose](): Promise<void>

  • Returns Promise<void>

addListener

  • addListener(event, listener): this

  • Emitted when the browser server closes.

    Parameters

    • event: "close"
    • listener: (() => any)
        • (): any

        • Returns any

    Returns this

close

  • close(): Promise<void>

  • Closes the browser gracefully and makes sure the process is terminated.

    Returns Promise<void>

kill

  • kill(): Promise<void>

  • Kills the browser process and waits for the process to exit.

    Returns Promise<void>

off

  • off(event, listener): this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "close"
    • listener: (() => any)
        • (): any

        • Returns any

    Returns this

on

  • on(event, listener): this

  • Emitted when the browser server closes.

    Parameters

    • event: "close"
    • listener: (() => any)
        • (): any

        • Returns any

    Returns this

once

  • once(event, listener): this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "close"
    • listener: (() => any)
        • (): any

        • Returns any

    Returns this

prependListener

  • prependListener(event, listener): this

  • Emitted when the browser server closes.

    Parameters

    • event: "close"
    • listener: (() => any)
        • (): any

        • Returns any

    Returns this

process

  • process(): ChildProcess

  • Spawned browser application process.

    Returns ChildProcess

removeListener

  • removeListener(event, listener): this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "close"
    • listener: (() => any)
        • (): any

        • Returns any

    Returns this

wsEndpoint

  • wsEndpoint(): string

  • Browser websocket url.

    Browser websocket endpoint which can be used as an argument to browserType.connect(endpoint[, options]) to establish connection to the browser.

    Returns string

Settings

Member Visibility

Theme

On This Page

[asyncDispose]addListenerclosekilloffononceprependListenerprocessremoveListenerwsEndpoint