BoundingBox

Last updated 5 months ago

Device

Chrome DevTools Device Emulation

Member

Default Value

Comment

blackBerryZ30

"BlackBerry Z30"

blackBerryZ30Landscape

"BlackBerry Z30 landscape"

blackberryPlayBook

"Blackberry PlayBook"

blackberryPlayBookLandscape

"Blackberry PlayBook landscape"

galaxyNoteIi

"Galaxy Note II"

galaxyNoteIiLandscape

"Galaxy Note II landscape"

galaxyNote_3

"Galaxy Note 3"

galaxyNote_3Landscape

"Galaxy Note 3 landscape"

galaxyS5

"Galaxy S5"

galaxyS5Landscape

"Galaxy S5 landscape"

galaxySIii

"Galaxy S III"

galaxySIiiLandscape

"Galaxy S III landscape"

iPad

"iPad"

iPadLandscape

"iPad landscape"

iPadMini

"iPad Mini"

iPadMiniLandscape

"iPad Mini landscape"

iPadPro

"iPad Pro"

iPadProLandscape

"iPad Pro landscape"

iPhone4

"iPhone 4"

iPhone4Landscape

"iPhone 4 landscape"

iPhone5

"iPhone 5"

iPhone5Landscape

"iPhone 5 landscape"

iPhone6

"iPhone 6"

iPhone6Landscape

"iPhone 6 landscape"

iPhone6Plus

"iPhone 6 Plus"

iPhone6PlusLandscape

"iPhone 6 Plus landscape"

iPhoneX

"iPhone X"

iPhoneXLandscape

"iPhone X landscape"

kindleFireHdx

"Kindle Fire HDX"

kindleFireHdxLandscape

"Kindle Fire HDX landscape"

lgOptimusL70

"LG Optimus L70"

lgOptimusL70Landscape

"LG Optimus L70 landscape"

microsoftLumia550

"Microsoft Lumia 550"

microsoftLumia950

"Microsoft Lumia 950"

microsoftLumia950Landscape

"Microsoft Lumia 950 landscape"

nexus10

"Nexus 10"

nexus10Landscape

"Nexus 10 landscape"

nexus4

"Nexus 4"

nexus4Landscape

"Nexus 4 landscape"

nexus5

"Nexus 5"

nexus5Landscape

"Nexus 5 landscape"

nexus5X

"Nexus 5X"

nexus5XLandscape

"Nexus 5X landscape"

nexus6

"Nexus 6"

nexus6Landscape

"Nexus 6 landscape"

nexus6P

"Nexus 6P"

nexus6PLandscape

"Nexus 6P landscape"

nexus7

"Nexus 7"

nexus7Landscape

"Nexus 7 landscape"

nokiaLumia_520

"Nokia Lumia 520"

nokiaLumia_520Landscape

"Nokia Lumia 520 landscape"

nokiaN9

"Nokia N9"

nokiaN9Landscape

"Nokia N9 landscape"

Key

Lists all available keyboard control keys which can be used when sending a key press combination.

Member

Default Value

Comment

ADD

""

ALT

""

ARROW_DOWN

""

ARROW_LEFT

""

ARROW_RIGHT

""

ARROW_UP

""

BACK_SPACE

""

CANCEL

""

CLEAR

""

COMMAND

""

CONTROL

""

DECIMAL

""

DELETE

""

DIVIDE

""

DOWN

""

END

""

ENTER

""

EQUALS

""

ESCAPE

""

F1

""

F10

""

F11

""

F12

""

F2

""

F3

""

F4

""

F5

""

F6

""

F7

""

F8

""

F9

""

HELP

""

HOME

""

INSERT

""

LEFT

""

META

""

MULTIPLY

""

NULL

""

NUMPAD0

""

NUMPAD1

""

NUMPAD2

""

NUMPAD3

""

NUMPAD4

""

NUMPAD5

""

NUMPAD6

""

NUMPAD7

""

NUMPAD8

""

NUMPAD9

""

PAGE_DOWN

""

PAGE_UP

""

PAUSE

""

RETURN

""

RIGHT

""

SEMICOLON

""

SEPARATOR

""

SHIFT

""

SPACE

""

SUBTRACT

""

TAB

""

UP

""

MouseButtons

Specifies the available mouse buttons to use when clicking. The default is always left

Member

Default Value

Comment

LEFT

"left"

MIDDLE

"middle"

Middle mouse button

RIGHT

"right"

BoundingBox

  • height The height.

  • width The width.

  • x The x-coordinate of top-left corner.

  • y The y-coordinate of top-left corner.

ClickOptions

Specifies the available options to send when clicking to modify the click behaviour. For example, to send a double click, set clickCount: 2.

  • button <MouseButtons> (Optional) defaults to left

  • clickCount (Optional) defaults to 1

  • delay (Optional) Time to wait between mousedown and mouseup in milliseconds.

    Defaults to 0.

FloodProcessEnv

  • BROWSER_ID

  • FLOOD_GRID_INDEX

  • FLOOD_GRID_NODE_SEQUENCE_ID

  • FLOOD_GRID_REGION

  • FLOOD_GRID_SQEUENCE_ID

  • FLOOD_NODE_INDEX

  • FLOOD_PROJECT_ID

  • FLOOD_SEQUENCE_ID

  • SEQUENCE Globally unique sequence number for this browser instance.

NavigationOptions

This interface represents the available options to pass to <Driver>.visit()

  • timeout (Optional) Maximum navigation time in milliseconds, pass 0 to disable timeout.

  • waitUntil (Optional) When to consider navigation succeeded.

ScreenshotOptions

Defines the screenshot options.

  • clip <BoundingBox> (Optional) An object which specifies clipping region of the page.

  • fullPage (Optional) When true, takes a screenshot of the full scrollable page.

  • omitBackground (Optional) Hides default white background and allows capturing screenshots with transparency.

  • path (Optional) The file path to save the image to. The screenshot type will be inferred from file extension.

    If path is a relative path, then it is resolved relative to current working directory.

    If no path is provided, the image won't be saved to the disk.

  • quality (Optional) The quality of the image, between 0-100. Not applicable to png images.

  • type (Optional) The screenshot type.

StepOptions

Specifies the available options which can be supplied to a step to override global settings.

Example:

step("Step 1", { waitTimeout: 300 }, async browser => {
await browser.click(...)
})
  • waitTimeout (Optional) Timeout in seconds for all wait and navigation operations within this <step>.

TestDataRow

TestSettings

This interface specifies the available options you can use to configure how your test runs. These properties should be exported using the property settings.

Example:

export const settings = {
loopCount: Infinity,
clearCache: true
}
  • DOMSnapshotOnFailure (Optional) Take a DOM snapshot of the page when a command fails, to aid in debugging.

  • actionDelay (Optional) Specifies the time (in seconds) to wait between each action call, to simulate a normal user

    thinking about what to do next.

  • clearCache (Optional) Specifies whether Brwoser cache should be cleared after each loop.

  • clearCookies (Optional) Specifies whether cookies should be cleared after each loop.

  • consoleFilter <ConsoleMethod> (Optional) Filters the console output from the target site to log output. Useful for very noisy tests. This won't affect console output from within your script.

  • description (Optional) Speicifies the description of the test specified in the comments section

  • device (Optional) Specifies a device to emulate with browser device emulation.

  • disableCache (Optional) Disables browser request cache for all requests.

  • duration (Optional) Maximum duration to run this for, regardless of other timeouts specified on Flood.

Defaults to -1 for no timeout.

  • ignoreHTTPSErrors (Optional) Whether to ignore HTTPS errors during navigation. Defaults to false

  • loopCount (Optional) Number of times to run this test.

    Defaults to -1 for infinite.

  • name (Optional) Speicifies the name of the test specified in the comments section

  • responseTimeMeasurement <ResponseTiming> (Optional) Configures how we record response time for each step.

Possible values:

  • "page": Record the document loading response time. This is usually what you consider response time on paged web apps.

  • "network": Takes the mean response time of all network requests which occur during a step. This is useful for Single Page Application which don't actually trigger a navigation.

  • "step": (Default) Records the wall clock time of a step. This is useful for Single Page Application which don't actually trigger a navigation.

  • "stepWithThinkTime": Records the wall clock time of a step including actionDelay time.

  • screenshotOnFailure (Optional) Take a screenshot of the page when a command fails, to aid in debugging.

Screenshots are saved to /flood/result/screenshots in the test archive.

  • stepDelay (Optional) Specifies the time (in seconds) to wait after each step.

  • userAgent (Optional) Specifies a custom User Agent (UA) string to send.

  • waitTimeout (Optional) Global wait timeout applied to all wait tasks

ConsoleMethod

Driver

EvaluateFn

FeedFilterFunction

Locatable

ResponseTiming

StepDefinition

StepFunction