@brimp/brimp API
    Preparing search index...

    Class Page

    An HTTP result and its live DOM. A successful request replaces its HTTP metadata. HTTP properties require a response; newPage() and loadHtml() have none.

    Hierarchy (View Summary)

    Index
    content: Buffer
    cookies: [string, string][]
    downloadedBytes: number
    elapsed: number

    Milliseconds.

    headerBytes: number
    headers: [string, string][]
    history: Redirect[]
    httpVersion: string | null
    reason: string
    requestInfo: RequestRecord

    Original HTTP request record; request() navigates the page.

    statusCode: number
    text: string

    Original HTTP response text. Use html() for the live DOM.

    uploadedBytes: number
    url: string
    • Parameters

      • source: string

      Returns Promise<void>

    • Parameters

      • milliseconds: number
      • Optionaloptions: { maxTasks?: number }

      Returns Promise<{ now: number; tasks: number }>

    • Returns void

    • Parameters

      • selector: string

      Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • source: string
      • destination: string

      Returns Promise<void>

    • Evaluate browser JavaScript, await Promises, and copy rich values, including bigint and binary buffers.

      Parameters

      • source: string

      Returns Promise<CopiedValue>

    • Parameters

      • source: string

      Returns Promise<JSHandle>

    • Parameters

      • selector: string
      • text: string

      Returns Promise<void>

    • Parameters

      • selector: string

      Returns Promise<void>

    • Parameters

      • selector: string

      Returns Promise<void>

    • Serialize the current DOM, including page-script and host edits.

      Returns Promise<string>

    • Load HTML at url without page scripts or subresources; url defaults to about:blank.

      Parameters

      • html: string
      • Optionalurl: string

      Returns Promise<void>

    • Type Parameters

      Parameters

      • event: E
      • handler: (record: PageEvents[E]) => void | Promise<void>

      Returns () => void

    post

    • Modifier bits: Alt=1, Control=2, Meta=4, Shift=8.

      Parameters

      • selector: string
      • key: string
      • Optionaloptions: { modifiers?: number }

      Returns Promise<void>

    • Throw HTTPError for a 4xx/5xx response. Other HTTP statuses return normally. A page without an HTTP response throws RuntimeError with code invalid_input.

      Returns void

    • Parameters

      • requestId: number

      Returns Buffer

    • Parameters

      • pattern: string
      • handler: (route: Route) => void | Promise<void>
      • Optionaloptions: { stage?: RouteStage }

      Returns () => void

    • Parameters

      • Optionaloptions: { maxTasks?: number }

      Returns Promise<{ now: number; tasks: number }>

    • Parameters

      Returns void

    • Parameters

      Returns Promise<void>

    • Registered runtime API shape claims, used to generate a browser capture plugin.

      Returns Promise<ShapeManifest>

    • Consume retained records and the dropped count. JSONL output is unaffected.

      Returns Promise<DiagnosticBatch>

    • Parameters

      • selector: string

      Returns Promise<void>

    • Parameters

      • selector: string
      • text: string

      Returns Promise<void>