BQL Generated Type Reference

Classes

Class	Description
Browser	Manages BAP pages connected to a Browserless BrowserQL endpoint.
Browserless	Entry point for creating BAP browser sessions backed by Browserless BrowserQL.
BrowserQLError	Raised when the BrowserQL server returns GraphQL errors.
ConnectionError	Raised when the WebSocket connection fails, drops, or is unavailable.
ElementHandle	A handle to a matched element.
EventEmitter	Minimal typed event emitter backing the puppeteer-style Page event API.
Page	-
TimeoutError	Raised when an operation exceeds its timeout.
Transport	-
WebSocketTransport	The built-in ConnectionTransport: a WebSocket via #platform (native in the browser, ws in Node so the User-Agent header can be sent). This is what the library uses whenever no custom transport is supplied — connecting to a WebSocket URL goes through WebSocketTransport.create, which negotiates the SUBPROTOCOL subprotocol.

Functions

Function	Description
buildOperation	Builds a parameterized GraphQL mutation document and its accompanying variables payload. Argument values are passed as GraphQL variables rather than interpolated into the query string, which lets the server coerce and validate them by type (including enums and input objects) and keeps the operation document constant across calls.

Interfaces

Interface	Description
AddScriptTagOptions	-
AddScriptTagResponse	Response returned after injecting a script tag
AddStyleTagOptions	-
AddStyleTagResponse	Response returned after injecting a style tag
Attribute	-
AuthenticateOptions	-
CaptchaResponse	Response returned after a captcha has been solved
CheckboxOptions	-
CleanInput	Options for cleaning up the DOM prior to exporting its content. Many options are available, and this query can destructively remove non-text DOM nodes, DOM attributes, and gratuitous whitespace characters. Since these operations are destructive in their nature it's recommended to run them at the very end of your query in order to preserve page functionality
ClickOptions	-
ClickResponse	Response returned after having clicked on an element
ConnectionTransport	A user-suppliable transport, modeled on puppeteer's ConnectionTransport. Pass one via ConnectOptions.transport to send BrowserQL frames over your own channel instead of the built-in WebSocket. The frames it relays are graphql-transport-ws envelopes (SUBPROTOCOL) — the transport is just the pipe, Transport does the framing on top.
ConnectOptions	-
ConsoleMessage	A console message emitted by the page. Mirrors puppeteer's ConsoleMessage, sourced from CDP Runtime.consoleAPICalled and Runtime.exceptionThrown.
ConsoleMessageLocation	The source location a console message originated from.
CookieInput	The cookie to be sent to the page
CookiePartitionKeyInput	-
CookieResponse	The response returned after setting or getting cookies
DefaultResponse	Default response for all methods
EmulateMediaTypeOptions	-
EmulateMediaTypeResponse	Response returned after emulating a CSS media type
EvaluateOptions	-
EvaluateResponse	Response returned after evaluating a script
FulfillOptions	-
FulfillResponse	Response returned after registering a request-fulfillment interceptor
GotoOptions	-
HeaderInput	A HTTP header input type
HoverOptions	-
HoverResponse	Response returned after having hovered over an element
HTMLOptions	-
HTMLResourcePathInput	A resource URL and its replacement archive path when rewriting HTML for export.
HTMLResponse	HTML content of a page
HTMLRewriteInput	Options for rewriting page resource URLs before returning HTML.
HTTPHeaders	An object representing the header's name and underlying value
HTTPHeadersResponse	The response returned after setting HTTP headers
HTTPResponse	Response returned after a navigation event
JavaScriptEnabledOptions	-
JavaScriptResponse	The response returned after enabling or disabling JavaScript on the page
LiveURLOptions	-
LiveURLResponse	The response from the Live-URL query
LoadSecretOptions	-
LoadSecretResponse	Response returned after attempting to fill a credential resolved from a 1Password integration. The resolved value is never included in the response.
MapSelectorOptions	-
MapSelectorResponse	Response returned from a Map Selector
MarkdownOptions	-
MarkdownResponse	Response returned after converting the page content to Markdown
NavigationOptions	-
PageEventMap	Maps each Page event name to the payload delivered to its listeners. Backed by a GraphQL subscription that is opened lazily on first listen.
PDFOptions	-
PDFResponse	The response returned after generating a PDF
PreferencesOptions	-
ProxyOptions	-
ProxyResponse	Response returned after setting up the proxy patterns
QuerySelectorOptions	-
QuerySelectorResponse	The response returned after querying the page for a selector
ReconnectionResponse	The response received after attempting to reconnect a BrowserQL session
ReconnectOptions	-
RejectOptions	-
RejectResponse	The response parameters for the reject mutation
RequestFilterOptions	-
RequestHeader	An object representing the header's name and underlying value
RequestInput	The specific request to perform a conditional action on
RequestResponse	Response returned from the request API
ResponseFilterOptions	-
ResponseInput	The specific response to perform a conditional action on
ResponseResponse	Response returned from the response API
ScreenshotClip	The clipping to be applied to the screenshot
ScreenshotOptions	-
ScreenshotResponse	The response returned after generating a Screenshot
ScrollOptions	-
ScrollResponse	Response returned after having scrolling inside the page
SelectOptions	-
SelectResponse	The response returned after selecting a value from a dropdown or multiple select element
SendOptions	-
SetContentOptions	-
SetCookieOptions	-
SetExtraHTTPHeadersOptions	-
SolveImageCaptchaOptions	-
SolveOptions	-
StandardCookie	A standard cookie
StopSessionRecordingResponse	The response received after stopping session recording
SubscriptionSpec	-
SwitchToWindowOptions	-
SwitchWindowResponse	Response from window switching operation
TextOptions	-
TextResponse	Text content of a page
TitleResponse	Response returned after the page's title has been set or get
TypeOptions	-
TypeResponse	Response returned after having typed into an element
URLResponse	Response returned after the URL of the page has been set or get
UserAgentResponse	The response returned after setting the User-Agent
ViewportOptions	-
ViewportResponse	Response returned after setting the viewport
WaitForEvent	Response returned after having waited for an event to fire on the page
WaitForEventOptions	-
WaitForFunction	Response returned after having waited for a JavaScript predicate to become truthy
WaitForFunctionOptions	-
WaitForNavigationOptions	-
WaitForNetworkIdleOptions	-
WaitForRequestOptions	-
WaitForRequestResponse	Response returned after a particular network request has been sent
WaitForResponseOptions	-
WaitForResponseResponse	Response returned after a particular network response has been received
WaitForSelectorOptions	-
WaitForSelectorResponse	Response returned after a particular selector has been found in the DOM
WaitForTimeoutResponse	Response returned after having waited for a selector to appear in the DOM

References

default

Renames and re-exports Browserless

Type Aliases

Type Alias	Description
AttributeMode	Controls how the attributes field is interpreted in cleaning operations
CaptchaType	The different types of captchas that can be solved
ConsoleMessageType	The kind of console message, mirroring the CDP Runtime.consoleAPICalled type (and puppeteer's ConsoleMessageType). Uncaught exceptions are reported as error.
CookiePriority	-
CookieSameSite	The values a cookie's SameSite attribute can hold
CookieSourceScheme	-
CountryCode	The two-letter ISO code for the specified country
Listener	-
LiveURLStreamType	The binary-type of the stream
MediaType	The CSS media type to emulate for the page
MessageListener	A raw-frame listener registered via Page.on/Page.subscribe.
Method	The various HTTP-based methods to wait for
OperatorType	Logical operators for APIs that have conditions
PageEvents	Page events surfaced through the puppeteer-style emitter. The schema-derived PageEventMap entries (console/request/response) each open a GraphQL subscription lazily; error is emitted if opening or streaming one fails (it never throws, matching puppeteer's non-fatal emitter errors). message carries every raw frame the transport receives — including server-pushed frames with no matching operation (e.g. data over a custom ConnectionTransport); it is not subscription-backed.
PDFPageFormat	The values a pdf's Size attribute can hold
ProxyNetwork	The Browserless proxy network to route matching requests through.
ResourceType	The type of resource for a given network or HTTP request
ScreenshotType	The different types of screenshot formats
TransportFactory	Builds a ConnectionTransport for a given endpoint URL. Supply one via ConnectOptions.transport to override the default WebSocket transport. The returned promise must resolve only once the connection is open — the library begins sending frames as soon as it resolves. This is a factory rather than a single instance because Browser.newPage invokes it per page and Transport assigns onmessage/onclose/onerror on the returned transport each time — so every page must get a fresh transport instance. Reusing one instance across pages would overwrite the earlier pages' handlers and cross-wire their frames, unless the transport itself multiplexes.
WaitForFunctionPolling	Browser-driven polling modes for waitForFunction
WaitUntilGoto	Options for when to consider the page has loaded and proceed with further execution
WaitUntilHistory	The different stages of the browser's loading process

Variables

Variable	Description
ARG_TYPES	-
RESPONSE_FIELDS	-
SUBSCRIPTIONS	-