Skip to content

Latest commit

 

History

History
519 lines (333 loc) · 10.2 KB

api.md

File metadata and controls

519 lines (333 loc) · 10.2 KB
Raw

API Documentation

Chromeless provides TypeScrip typings.

Chromeless methods

Chrome methods

end(): Promise

End the Chromeless session. Locally this will disconnect from Chrome. Over the Proxy, this will end the session, terminating the Lambda function. It returns the last value that has been evaluated.

await chromeless.end()

goto(url: string): Chromeless

Navigate to a URL.

Arguments

  • url - URL to navigate to

Example

await chromeless.goto('https://google.com/')

click(selector: string): Chromeless

Click on something in the DOM.

Arguments

  • selector - DOM selector for element to click

Example

await chromeless.click('#button')

wait(timeout: number): Chromeless

Wait for some duration. Useful for waiting for things download.

Arguments

  • timeout - How long to wait, in ms

Example

await chromeless.wait(1000)

wait(selector: string): Chromeless

Wait until something appears. Useful for waiting for things to render.

Arguments

  • selector - DOM selector to wait for

Example

await chromeless.wait('div#loaded')

wait(fn: (...args: any[]) => boolean, ...args: any[]): Chromeless

Wait until a function returns.

Arguments

  • fn - Function to wait for
  • [arguments] - Arguments to pass to the function

Example

await chromeless.wait(() => { return console.log('@TODO: put a better example here') })

focus(selector: string): Chromeless

Provide focus on a DOM element.

Arguments

  • selector - DOM selector to focus

Example

await chromeless.focus('input#searchField')

press(keyCode: number, count?: number, modifiers?: any): Chromeless

Send a key press. Enter, for example.

Arguments

  • keyCode - Key code to send
  • count - How many times to send the key press
  • modifiers - Modifiers to send along with the press (e.g. control, command, or alt)

Example

await chromeless.press(13)

type(input: string, selector?: string): Chromeless

Type something (into a field, for example).

Arguments

  • input - String to type
  • selector - DOM element to type into

Example

const result = await chromeless
  .goto('https://www.google.com')
  .type('chromeless', 'input[name="q"]')

back() - Not implemented yet

Not implemented yet

forward() - Not implemented yet

Not implemented yet

refresh() - Not implemented yet

Not implemented yet

mousedown() - Not implemented yet

Not implemented yet

mouseup() - Not implemented yet

Not implemented yet

scrollTo(x: number, y: number): Chromeless

Scroll to somewhere in the document.

Arguments

  • x - Offset from top of the document
  • y - Offset from the left of the document

Example

await chromeless.scrollTo(500, 0)

viewport(width: number, height: number)

Resize the viewport. Useful if you want to capture more or less of the document in a screenshot.

Arguments

  • width - Viewport width
  • height - Viewport height

Example

await chromeless.viewport(1024, 800)

evaluate(fn: (...args: any[]) => void, ...args: any[]): Chromeless

Evaluate Javascript code within Chrome in the context of the DOM.

Arguments

  • fn - Function to evaluate within Chrome
  • [arguments] - Arguments to pass to the function

Example

await chromeless.evaluate(() => {
    // this will be executed in Chrome
    const links = [].map.call(
      document.querySelectorAll('.g h3 a'),
      a => ({title: a.innerText, href: a.href})
    )
    return JSON.stringify(links)
  })

inputValue(selector: string): Chromeless

Get the value of an input field.

Arguments

  • selector - DOM input element

Example

await chromeless.inputValue('input#searchField')

exists(selector: string): Chromeless

Test if a DOM element exists in the document.

Arguments

  • selector - DOM element to check for

Example

await chromeless.exists('div#ready')

screenshot(): Chromeless

Take a screenshot of the document as framed by the viewport. When running Chromeless locally this returns the local file path to the screenshot image. When run over the Chromeless Proxy service, a URL to the screenshot on S3 is returned.

Example

const screenshot = await chromeless
  .goto('https://google.com/')
  .screenshot()

console.log(screenshot) // prints local file path or S3 URL

pdf() - Not implemented yet

Not implemented yet

cookiesGet(): Chromeless<Cookie[] | null>

Returns all browser cookies for the current URL.

Example

await chromeless.cookiesGet()

cookiesGet(name: string): Chromeless<Cookie | null>

Returns a specific browser cookie by name for the current URL.

Arguments

  • name - Name of the cookie to get

Example

const cookie = await chromeless.cookiesGet('creepyTrackingCookie')

cookiesGet(query: CookieQuery) - Not implemented yet

Not implemented yet

cookiesGetAll(): Chromeless<Cookie[]>

Returns all browser cookies. Nam nom nom.

Example

await chromeless.cookiesGetAll()

cookiesSet(name: string, value: string): Chromeless

Sets a cookie with the given name and value.

Arguments

  • name - Name of the cookie
  • value - Value of the cookie

Example

await chromeless.cookiesSet('visited', '1')

cookiesSet(cookie: Cookie): Chromeless

Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.

Arguments

  • cookie - The cookie data to set

Example

await chromeless.cookiesSet({
  url: 'http://google.com/',
  domain: 'google.com',
  name: 'userData',
  value: '{}',
  path: '/',
  expires: 0,
  size: 0,
  httpOnly: false,
  secure: true,
  session: true,
})

cookiesSet(cookies: Cookie[]): Chromeless

Sets many cookies with the given cookie data; may overwrite equivalent cookies if they exist.

Arguments

  • url - URL to navigate to

Example

await chromeless.cookiesSet([
  {
    url: 'http://google.com/',
    domain: 'google.com',
    name: 'userData',
    value: '{}',
    path: '/',
    expires: 0,
    size: 0,
    httpOnly: false,
    secure: true,
    session: true,
  }, {
    url: 'http://bing.com/',
    domain: 'bing.com',
    name: 'userData',
    value: '{}',
    path: '/',
    expires: 0,
    size: 0,
    httpOnly: false,
    secure: true,
    session: true,
  }
])

cookiesClear(name: string) - Not implemented yet

Not implemented yet

cookiesClearAll(): Chromeless

Clears browser cookies.

Example

await chromeless.cookiesClearAll()