SongGuess
    Preparing search index...

    Interface BrowserRunBaseOptions

    Options fields shared by all quick actions.

    interface BrowserRunBaseOptions {
        actionTimeout?: number;
        addScriptTag?: {
            content?: string;
            id?: string;
            type?: string;
            url?: string;
        }[];
        addStyleTag?: { content?: string; url?: string }[];
        allowRequestPattern?: string[];
        allowResourceTypes?: BrowserRunResourceType[];
        authenticate?: { password: string; username: string };
        bestAttempt?: boolean;
        cacheTTL?: number;
        cookies?: {
            domain?: string;
            expires?: number;
            httpOnly?: boolean;
            name: string;
            partitionKey?: string;
            path?: string;
            priority?: "Low" | "Medium" | "High";
            sameParty?: boolean;
            sameSite?: "Strict" | "Lax" | "None";
            secure?: boolean;
            sourcePort?: number;
            sourceScheme?: "Unset" | "NonSecure" | "Secure";
            url?: string;
            value: string;
        }[];
        emulateMediaType?: string;
        gotoOptions?: {
            referer?: string;
            referrerPolicy?: string;
            timeout?: number;
            waitUntil?: BrowserRunLifecycleEvent
            | BrowserRunLifecycleEvent[];
        };
        rejectRequestPattern?: string[];
        rejectResourceTypes?: BrowserRunResourceType[];
        setExtraHTTPHeaders?: Record<string, string>;
        setJavaScriptEnabled?: boolean;
        userAgent?: string;
        viewport?: {
            deviceScaleFactor?: number;
            hasTouch?: boolean;
            height: number;
            isLandscape?: boolean;
            isMobile?: boolean;
            width: number;
        };
        waitForSelector?: {
            hidden?: true;
            selector: string;
            timeout?: number;
            visible?: true;
        };
        waitForTimeout?: number;
    }
    Index

    Properties

    actionTimeout? addScriptTag? addStyleTag? allowRequestPattern? allowResourceTypes? authenticate? bestAttempt? cacheTTL? cookies? emulateMediaType? gotoOptions? rejectRequestPattern? rejectResourceTypes? setExtraHTTPHeaders? setJavaScriptEnabled? userAgent? viewport? waitForSelector? waitForTimeout?

    Properties

    actionTimeout?: number

    Maximum duration in milliseconds for the browser action after page load. Max 120000

    addScriptTag?: { content?: string; id?: string; type?: string; url?: string }[]

    Adds <script> tags into the page with the desired URL or content.

    https://pptr.dev/api/puppeteer.frameaddscripttagoptions

    addStyleTag?: { content?: string; url?: string }[]

    Adds <link rel="stylesheet"> or <style> tags into the page.

    https://pptr.dev/api/puppeteer.frameaddstyletagoptions

    allowRequestPattern?: string[]

    Only allow requests matching these regex patterns. Mutually exclusive with rejectRequestPattern.

    allowResourceTypes?: BrowserRunResourceType[]

    Only allow requests of these resource types. Mutually exclusive with rejectResourceTypes.

    authenticate?: { password: string; username: string }

    Provide credentials for HTTP authentication.

    https://pptr.dev/api/puppeteer.credentials

    bestAttempt?: boolean

    When true, continue on best-effort when awaited events fail or timeout.

    cacheTTL?: number

    Cache time to live in seconds (0-86400). Set to 0 to disable.

    5
    cookies?: {
        domain?: string;
        expires?: number;
        httpOnly?: boolean;
        name: string;
        partitionKey?: string;
        path?: string;
        priority?: "Low" | "Medium" | "High";
        sameParty?: boolean;
        sameSite?: "Strict" | "Lax" | "None";
        secure?: boolean;
        sourcePort?: number;
        sourceScheme?: "Unset" | "NonSecure" | "Secure";
        url?: string;
        value: string;
    }[]

    Set cookies before navigating.

    https://pptr.dev/api/puppeteer.cookieparam

    emulateMediaType?: string

    Emulate a specific CSS media type (e.g. "screen", "print").

    gotoOptions?: {
        referer?: string;
        referrerPolicy?: string;
        timeout?: number;
        waitUntil?: BrowserRunLifecycleEvent | BrowserRunLifecycleEvent[];
    }

    Navigation options.

    Type Declaration

    • Optionalreferer?: string
    • OptionalreferrerPolicy?: string
    • Optionaltimeout?: number

      Navigation timeout in milliseconds (max 60 000).

      30000
    • OptionalwaitUntil?: BrowserRunLifecycleEvent | BrowserRunLifecycleEvent[]

      When to consider navigation complete.

      "domcontentloaded"

    https://pptr.dev/api/puppeteer.gotooptions

    rejectRequestPattern?: string[]

    Block requests matching these regex patterns. Mutually exclusive with allowRequestPattern.

    rejectResourceTypes?: BrowserRunResourceType[]

    Block requests of these resource types. Mutually exclusive with allowResourceTypes.

    setExtraHTTPHeaders?: Record<string, string>

    Additional HTTP headers sent with every request.

    setJavaScriptEnabled?: boolean

    Whether JavaScript is enabled on the page.

    userAgent?: string

    Override the default user agent string.

    "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36"
    viewport?: {
        deviceScaleFactor?: number;
        hasTouch?: boolean;
        height: number;
        isLandscape?: boolean;
        isMobile?: boolean;
        width: number;
    }

    Set the browser viewport size.

    https://pptr.dev/api/puppeteer.viewport

    {width:1920,height:1080}
    waitForSelector?: {
        hidden?: true;
        selector: string;
        timeout?: number;
        visible?: true;
    }

    Wait for a CSS selector to appear in the page before proceeding.

    Type Declaration

    • Optionalhidden?: true
    • selector: string
    • Optionaltimeout?: number

      Timeout in milliseconds. Max 120000

    • Optionalvisible?: true

    https://pptr.dev/api/puppeteer.waitforselectoroptions

    waitForTimeout?: number

    Wait for a fixed delay in milliseconds before proceeding. Max 120000

    Settings

    Member Visibility

    On This Page

    Properties