Skip to main content

browser

@codebolt/codeboltjs

Variable: browser

const browser: {
  click: (elementid: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>;
  close: (options?: BrowserOperationOptions) => Promise<void>;
  closeBrowserInstance: (instanceId: string) => Promise<boolean>;
  enter: (options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>;
  executeOnInstance: (instanceId: string, operation: BrowserOperationType, params: BrowserOperationParams) => Promise<BrowserOperationResponse>;
  extractText: (options?: BrowserOperationOptions) => Promise<ExtractTextResponse>;
  getBrowserInfo: (options?: BrowserOperationOptions) => Promise<BrowserInfoResponse>;
  getBrowserInstance: (instanceId: string) => Promise<BrowserInstanceInfo | null>;
  getContent: (options?: BrowserOperationOptions) => Promise<GetContentResponse>;
  getHTML: (options?: BrowserOperationOptions) => Promise<HtmlReceived>;
  getMarkdown: (options?: BrowserOperationOptions) => Promise<GetMarkdownResponse>;
  getPDF: (options?: BrowserOperationOptions) => Promise<void>;
  getSnapShot: (options?: BrowserOperationOptions) => Promise<BrowserSnapshotResponse>;
  getUrl: (options?: BrowserOperationOptions) => Promise<UrlResponse>;
  goToPage: (url: string, options?: BrowserOperationOptions) => Promise<GoToPageResponse>;
  listBrowserInstances: () => Promise<BrowserInstanceInfo[]>;
  newPage: (options?: BrowserInstanceOptions) => Promise<BrowserActionResponseData>;
  openNewBrowserInstance: (options?: BrowserInstanceOptions) => Promise<{
     instanceId: string;
  }>;
  pdfToText: (options?: BrowserOperationOptions) => Promise<void>;
  screenshot: (options?: BrowserScreenshotOptions) => Promise<BrowserScreenshotResponse>;
  scroll: (direction: string, pixels: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>;
  search: (elementid: string, query: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>;
  setActiveBrowserInstance: (instanceId: string) => Promise<boolean>;
  type: (elementid: string, text: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>;
};

Defined in: packages/codeboltjs/src/modules/browser.ts:55

A module for interacting with a browser through WebSockets.

Type Declaration​

NameTypeDescriptionDefined in
click()(elementid: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>Clicks on a specified element on the page.packages/codeboltjs/src/modules/browser.ts:317
close()(options?: BrowserOperationOptions) => Promise<void>Closes the current page.packages/codeboltjs/src/modules/browser.ts:260
closeBrowserInstance()(instanceId: string) => Promise<boolean>Close a browser instancepackages/codeboltjs/src/modules/browser.ts:441
enter()(options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>Simulates the Enter key press on the current page.packages/codeboltjs/src/modules/browser.ts:335
executeOnInstance()(instanceId: string, operation: BrowserOperationType, params: BrowserOperationParams) => Promise<BrowserOperationResponse>Execute action on specific browser instancepackages/codeboltjs/src/modules/browser.ts:464
extractText()(options?: BrowserOperationOptions) => Promise<ExtractTextResponse>Extracts text from the current page.packages/codeboltjs/src/modules/browser.ts:244
getBrowserInfo()(options?: BrowserOperationOptions) => Promise<BrowserInfoResponse>Retrieves browser info like height width scrollx scrolly of the current page.packages/codeboltjs/src/modules/browser.ts:227
getBrowserInstance()(instanceId: string) => Promise<BrowserInstanceInfo | null>Get a specific browser instance by IDpackages/codeboltjs/src/modules/browser.ts:397
getContent()(options?: BrowserOperationOptions) => Promise<GetContentResponse>Retrieves the content of the current page.packages/codeboltjs/src/modules/browser.ts:195
getHTML()(options?: BrowserOperationOptions) => Promise<HtmlReceived>Retrieves the HTML content of the current page.packages/codeboltjs/src/modules/browser.ts:135
getMarkdown()(options?: BrowserOperationOptions) => Promise<GetMarkdownResponse>Retrieves the Markdown content of the current page.packages/codeboltjs/src/modules/browser.ts:152
getPDF()(options?: BrowserOperationOptions) => Promise<void>Retrieves the PDF content of the current page.packages/codeboltjs/src/modules/browser.ts:168
getSnapShot()(options?: BrowserOperationOptions) => Promise<BrowserSnapshotResponse>Retrieves the snapshot of the current page.packages/codeboltjs/src/modules/browser.ts:211
getUrl()(options?: BrowserOperationOptions) => Promise<UrlResponse>Retrieves the current URL of the browser's active page.packages/codeboltjs/src/modules/browser.ts:79
goToPage()(url: string, options?: BrowserOperationOptions) => Promise<GoToPageResponse>Navigates to a specified URL.packages/codeboltjs/src/modules/browser.ts:97
listBrowserInstances()() => Promise<BrowserInstanceInfo[]>List all open browser instancespackages/codeboltjs/src/modules/browser.ts:376
newPage()(options?: BrowserInstanceOptions) => Promise<BrowserActionResponseData>Opens a new page in the browser.packages/codeboltjs/src/modules/browser.ts:61
openNewBrowserInstance()(options?: BrowserInstanceOptions) => Promise<{ instanceId: string; }>Open a new browser instancepackages/codeboltjs/src/modules/browser.ts:422
pdfToText()(options?: BrowserOperationOptions) => Promise<void>Converts the PDF content of the current page to text.packages/codeboltjs/src/modules/browser.ts:181
screenshot()(options?: BrowserScreenshotOptions) => Promise<BrowserScreenshotResponse>Takes a screenshot of the current page.packages/codeboltjs/src/modules/browser.ts:114
scroll()(direction: string, pixels: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>Scrolls the current page in a specified direction by a specified number of pixels.packages/codeboltjs/src/modules/browser.ts:276
search()(elementid: string, query: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>Performs a search on the current page using a specified query.packages/codeboltjs/src/modules/browser.ts:354
setActiveBrowserInstance()(instanceId: string) => Promise<boolean>Set the active browser instancepackages/codeboltjs/src/modules/browser.ts:407
type()(elementid: string, text: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>Types text into a specified element on the page.packages/codeboltjs/src/modules/browser.ts:297