Rize API Documentation
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • RizeOptions

Index

Properties

Methods

Properties

Optional browser

browser: puppeteer.Browser

Use an existing puppeteer's browser instance.

example

(async () => {
  const browser = await puppeteer.launch()
  const rize = new Rize({ browser })
})()

Optional defaultNavigationTimeout

defaultNavigationTimeout: undefined | number

This setting will change the default maximum navigation time of 30 seconds for the following methods:

  • Rize#goto(url)
  • Rize#forward()
  • Rize#back()
  • Rize#refresh()
  • Rize#waitForNavigation(timeout?)

Optional height

height: undefined | number

Height of viewport.

Optional width

width: undefined | number

Width of viewport.

Methods

Optional afterEachStep

  • afterEachStep(this: Rize): void

  • A lifecycle hook which you can do something after each step.

    this context points to the Rize instance. So you can visit browser and page here. (Like this.browser or this.page)

    example
    
const rize = new Rize({
  afterEachStep () {
    this === rize  // true
    console.log('I will be called after each step!')
  }
})

    Parameters

    Returns void

Optional afterLaunched

  • afterLaunched(this: Rize): void

  • A lifecycle hook which you can do something after the browser launched.

    this context points to the Rize instance. So you can visit browser and page here. (Like this.browser or this.page)

    example
    
const rize = new Rize({
  afterLaunched () {
    this === rize  // true
    console.log('The browser has launched.')
  }
})

    Parameters

    Returns void

Optional beforeEachStep

  • beforeEachStep(this: Rize): void

  • A lifecycle hook which you can do something before each step.

    this context points to the Rize instance. So you can visit browser and page here. (Like this.browser or this.page)

    example
    
const rize = new Rize({
  beforeEachStep () {
    this === rize  // true
    console.log('I will be called before each step!')
  }
})

    Parameters

    Returns void

Optional beforeExit

  • beforeExit(this: Rize): void

  • A lifecycle hook which you can do something before the browser exit.

    this context points to the Rize instance. So you can visit browser and page here. (Like this.browser or this.page)

    example
    
const rize = new Rize({
  beforeExit () {
    this === rize  // true
    console.log('The browser is going to exit.')
  }
})

    Parameters

    Returns void

Optional beforeLaunch

  • beforeLaunch(): void

  • A lifecycle hook which you can do something before the browser launching.

    example
    
const rize = new Rize({
  beforeLaunch () {
    console.log('The browser is going to launch.')
  }
})

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc