@flood/chrome - npm Package Compare versions

Comparing version 0.1.13 to 0.1.14

1120

index.d.ts

		@@ -6,90 +6,90 @@ // Type definitions for @flood/chrome 0.1.12
		export interface TestSettings {
		/**
		* Maximum duration to run this for, regardless of other timeouts specified on Flood.
		*
		* Defaults to `-1` for no timeout.
		*/
		duration?: number
		/**
		* Maximum duration to run this for, regardless of other timeouts specified on Flood.
		*
		* Defaults to `-1` for no timeout.
		*/
		duration?: number

		/**
		* Number of times to run this test.
		* Defaults to `-1` for infinite.
		*/
		loopCount?: number
		/**
		* Number of times to run this test.
		* Defaults to `-1` for infinite.
		*/
		loopCount?: number

		/**
		* Specifies the time (in seconds) to wait between each action call, to simulate a normal user
		* thinking about what to do next.
		*/
		actionDelay?: number
		/**
		* Specifies the time (in seconds) to wait between each action call, to simulate a normal user
		* thinking about what to do next.
		*/
		actionDelay?: number

		/**
		* Specifies the time (in seconds) to wait after each step.
		*/
		stepDelay?: number
		/**
		* Specifies the time (in seconds) to wait after each step.
		*/
		stepDelay?: number

		/**
		* Specifies a custom User Agent (UA) string to send.
		*/
		userAgent?: string
		/**
		* Specifies a custom User Agent (UA) string to send.
		*/
		userAgent?: string

		/**
		* Specifies a device to emulate with browser device emulation.
		*/
		device?: string
		/**
		* Specifies a device to emulate with browser device emulation.
		*/
		device?: string

		/**
		* Global wait timeout applied to all wait tasks
		*/
		waitTimeout?: number
		/**
		* Global wait timeout applied to all wait tasks
		*/
		waitTimeout?: number

		/**
		* Specifies whether cookies should be cleared after each loop.
		*
		* @default true
		*/
		clearCookies?: boolean
		/**
		* Specifies whether cookies should be cleared after each loop.
		*
		* @default true
		*/
		clearCookies?: boolean

		/**
		* Specifies whether Brwoser cache should be cleared after each loop.
		*
		* @default false
		*/
		clearCache?: boolean
		/**
		* Specifies whether Brwoser cache should be cleared after each loop.
		*
		* @default false
		*/
		clearCache?: boolean

		/**
		* Speicifies the name of the test specified in the comments section
		*/
		name?: string
		/**
		* Speicifies the name of the test specified in the comments section
		*/
		name?: string

		/**
		* Speicifies the description of the test specified in the comments section
		*/
		description?: string
		/**
		* Speicifies the description of the test specified in the comments section
		*/
		description?: string

		/**
		* 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.
		*/
		screenshotOnFailure?: boolean
		/**
		* 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.
		*/
		screenshotOnFailure?: boolean

		/**
		* Take a DOM snapshot of the page when a command fails, to aid in debugging.
		*/
		DOMSnapshotOnFailure?: boolean
		/**
		* Take a DOM snapshot of the page when a command fails, to aid in debugging.
		*/
		DOMSnapshotOnFailure?: boolean
		}

		export interface StepOptions {
		/**
		* Take a screenshot on failure.
		* @default true
		*/
		screenshotOnFailure?: boolean
		/**
		* Take a screenshot on failure.
		* @default true
		*/
		screenshotOnFailure?: boolean

		/**
		* Timeout in seconds for all wait and navigation operations.
		* @default `30` seconds
		*/
		timeout?: number
		/**
		* Timeout in seconds for all wait and navigation operations.
		* @default `30` seconds
		*/
		timeout?: number
		}
		@@ -114,223 +114,217 @@
		export declare function step(
		name: string,
		options: StepOptions,
		fn: (driver: Driver) => Promise<void>,
		name: string,
		options: StepOptions,
		fn: (driver: Driver) => Promise<void>,
		)

		export declare class Driver {
		/**
		* Clear browser cookies.
		*/
		public clearBrowserCookies(): Promise<any>
		/**
		* Clear browser cookies.
		*/
		public clearBrowserCookies(): Promise<any>

		/**
		* Clear browser cache.
		*/
		public clearBrowserCache(): Promise<any>
		/**
		* Clear browser cache.
		*/
		public clearBrowserCache(): Promise<any>

		/**
		* Configure Browser to emulate a given device
		*/
		public emulateDevice(deviceName: Device): Promise<void>
		/**
		* Configure Browser to emulate a given device
		*/
		public emulateDevice(deviceName: Device): Promise<void>

		/**
		* Set Browser to send a custom User Agent (UA) string
		*/
		public setUserAgent(userAgent: string): Promise<void>
		/**
		* Set Browser to send a custom User Agent (UA) string
		*/
		public setUserAgent(userAgent: string): Promise<void>

		/**
		* Instructs the browser to navigate to a specific page. This is typically used as the
		* entrypoint to your test, as the first instruction it is also responsible for creating
		* a new Browser tab for this page to load into.
		*
		* @param {string} url
		* @returns {Promise<void>}
		* @memberof Driver
		*/
		public visit(url: string, options?: NavigationOptions): Promise<void>
		/**
		* Instructs the browser to navigate to a specific page. This is typically used as the
		* entrypoint to your test, as the first instruction it is also responsible for creating
		* a new Browser tab for this page to load into.
		*
		* @param {string} url
		* @returns {Promise<void>}
		* @memberof Driver
		*/
		public visit(url: string, options?: NavigationOptions): Promise<void>

		/**
		* Creates a waiter which will pause the test until a condition is met or a timeout is reached.
		*
		* You can use either a numeric value in seconds to wait for a specific time,
		* or a {@linkcode Condition}, for more flexible conditions.
		*/
		public wait(timeoutOrCondition: Condition \| number): Promise<boolean>
		/**
		* Creates a waiter which will pause the test until a condition is met or a timeout is reached.
		*
		* You can use either a numeric value in seconds to wait for a specific time,
		* or a {@linkcode Condition}, for more flexible conditions.
		*/
		public wait(timeoutOrCondition: Condition \| number): Promise<boolean>

		/**
		* Sends a click event to the element located at `selector`. If the element is
		* currently outside the viewport it will first scroll to that element.
		*/
		public click(selectorOrLocator: string \| Locator, options?: ClickOptions): Promise<void>
		/**
		* Sends a click event to the element located at `selector`. If the element is
		* currently outside the viewport it will first scroll to that element.
		*/
		public click(selectorOrLocator: string \| Locator, options?: ClickOptions): Promise<void>

		/**
		* Sends a double-click event to the element located by the supplied Locator or `selector`. If the element is
		* currently outside the viewport it will first scroll to that element.
		*/
		public doubleClick(locatable: Locatable, options?: ClickOptions): Promise<void>
		/**
		* Sends a double-click event to the element located by the supplied Locator or `selector`. If the element is
		* currently outside the viewport it will first scroll to that element.
		*/
		public doubleClick(locatable: Locatable, options?: ClickOptions): Promise<void>

		/**
		* Selects an option within a <select> tag using the value of the <option> element.
		*/
		public selectByValue(locatable: Locatable, ...values: string[]): Promise<string[]>
		/**
		* Selects an option within a <select> tag using the value of the <option> element.
		*/
		public selectByValue(locatable: Locatable, ...values: string[]): Promise<string[]>

		/**
		* Selects an option within a <select> tag by its index in the list.
		*/
		public selectByIndex(locatable: Locatable, index: string): Promise<string[]>
		/**
		* Selects an option within a <select> tag by its index in the list.
		*/
		public selectByIndex(locatable: Locatable, index: string): Promise<string[]>

		/**
		* Selects an option within a <select> tag by matching its visible text.
		*/
		public selectByText(locatable: Locatable, text: string): Promise<string[]>
		/**
		* Selects an option within a <select> tag by matching its visible text.
		*/
		public selectByText(locatable: Locatable, text: string): Promise<string[]>

		/**
		* Clears the selected value of an input or select control.
		*/
		public clear(locatable: Locatable): Promise<void>
		/**
		* Clears the selected value of an input or select control.
		*/
		public clear(locatable: Locatable): Promise<void>

		/**
		* Types a string into an <input> control, key press by key press.
		*/
		public type(locatable: Locatable, text: string, options?: { delay: number }): Promise<void>
		/**
		* Types a string into an <input> control, key press by key press.
		*/
		public type(locatable: Locatable, text: string, options?: { delay: number }): Promise<void>

		public blur(locator: Locatable): Promise<void>
		public blur(locator: Locatable): Promise<void>

		public focus(locator: Locatable): Promise<void>
		public focus(locator: Locatable): Promise<void>

		public press(
		keyCode: string,
		options?: {
		/**
		* A string of text to type
		*/
		text?: string /**
		* Delay between key presses, in milliseconds.
		*/
		delay?: number
		},
		): Promise<void>
		public press(
		keyCode: string,
		options?: {
		/**
		* A string of text to type
		*/
		text?: string /**
		* Delay between key presses, in milliseconds.
		*/
		delay?: number
		},
		): Promise<void>

		/**
		* Takes a screenshot of the whole page and saves it to the results folder with a random sequential name.
		*/
		public takeScreenshot(options?: ScreenshotOptions): Promise<void>
		/**
		* Takes a screenshot of the whole page and saves it to the results folder with a random sequential name.
		*/
		public takeScreenshot(options?: ScreenshotOptions): Promise<void>

		/**
		* Uses the provided locator to find the first element it matches, returning an ElementHandle.
		*/
		public findElement(locator: string \| Locator): Promise<ElementHandle>
		/**
		* Uses the provided locator to find the first element it matches, returning an ElementHandle.
		*/
		public findElement(locator: string \| Locator): Promise<ElementHandle \| null>

		/**
		* Uses the provided locator to find all elements matching the locator condition, returning an array of ElementHandles
		*/
		public findAllElements(locator: string \| Locator): Promise<ElementHandle[]>
		/**
		* Uses the provided locator to find all elements matching the locator condition, returning an array of ElementHandles
		*/
		public findElements(locator: string \| Locator): Promise<ElementHandle[]>

		/**
		* Switch the focus of the browser to another frame or window
		*/
		public switchTo(): TargetLocator
		/**
		* Switch the focus of the browser to another frame or window
		*/
		public switchTo(): TargetLocator
		}

		declare class ElementHandle {
		/**
		* Fetches the value of an attribute on this element
		*
		* @param {string} name HTMLElementAttribute
		* @returns {Promise<string>}
		* @memberof ElementHandle
		*/
		public getAttribute(name: string): Promise<string>
		/**
		* Fetches the value of an attribute on this element
		*/
		public getAttribute(key: string): Promise<string \| null>

		/**
		* Sends a click event to the element attached to this handle. If the element is
		* currently outside the viewport it will first scroll to that element.
		*/
		public click(options?: ClickOptions): Promise<void>
		/**
		* Sends a click event to the element attached to this handle. If the element is
		* currently outside the viewport it will first scroll to that element.
		*/
		public click(options?: ClickOptions): Promise<void>

		/**
		* Schedules a command to clear the value of this element.
		* This command has no effect if the underlying DOM element is neither a text
		* INPUT, SELECT, or a TEXTAREA element.
		*/
		public clear(): Promise<void>
		/**
		* Schedules a command to clear the value of this element.
		* This command has no effect if the underlying DOM element is neither a text
		* INPUT, SELECT, or a TEXTAREA element.
		*/
		public clear(): Promise<void>

		public sendKeys(...keys: string[]): Promise<void>
		public sendKeys(...keys: string[]): Promise<void>

		public type(text: string): Promise<void>
		public type(text: string): Promise<void>

		/**
		* Sends focus to this element so that it receives keyboard inputs.
		*/
		public focus(): Promise<void>
		/**
		* Sends focus to this element so that it receives keyboard inputs.
		*/
		public focus(): Promise<void>

		/**
		* Clears focus from this element so that it will no longer receive keyboard inputs.
		*/
		public blur(): Promise<void>
		/**
		* Clears focus from this element so that it will no longer receive keyboard inputs.
		*/
		public blur(): Promise<void>

		/**
		* Takes a screenshot of this element and saves it to the results folder with a random name.
		*/
		public takeScreenshot(options?: ScreenshotOptions): Promise<void>
		/**
		* Takes a screenshot of this element and saves it to the results folder with a random name.
		*/
		public takeScreenshot(options?: ScreenshotOptions): Promise<void>

		/**
		* Locates an element using the supplied {@linkcode Locator}, returning an {@linkcode ElementHandle}
		*/
		public findElement(locator: Locator \| string): Promise<ElementHandle>
		/**
		* Locates an element using the supplied {@linkcode Locator}, returning an {@linkcode ElementHandle}
		*/
		public findElement(locator: string \| Locator): Promise<ElementHandle \| null>

		/**
		* Locates all elements using the supplied {@linkcode Locator}, returning an array of {@linkcode ElementHandle}'s
		*/
		public findElements(locator: Locator \| string): Promise<ElementHandle[]>
		/**
		* Locates all elements using the supplied {@linkcode Locator}, returning an array of {@linkcode ElementHandle}'s
		*/
		public findElements(locator: Locator \| string): Promise<ElementHandle[]>

		public tagName(): Promise<string>
		public tagName(): Promise<string \| null>

		public getId(): Promise<string>
		public getId(): Promise<string \| null>

		public getAttribute(key: string): Promise<string>
		public isSelected(): Promise<boolean>

		public isSelected(): Promise<boolean>
		public isSelectable(): Promise<boolean>

		public isSelectable(): Promise<boolean>
		public isDisplayed(): Promise<boolean>

		public isDisplayed(): Promise<boolean>
		public isEnabled(): Promise<boolean>

		public isEnabled(): Promise<boolean>
		/**
		* Retrieves the text content of this element excluding leading and trailing whitespace.
		*/
		public text(): Promise<string>

		/**
		* Retrieves the text content of this element excluding leading and trailing whitespace.
		*/
		public text(): Promise<string>
		public size(): Promise<{ width: number; height: number }>

		public size(): Promise<{ width: number; height: number }>

		public location(): Promise<{ x: number; y: number }>
		public location(): Promise<{ x: number; y: number }>
		}

		declare class TargetLocator {
		/**
		* Locates the DOM element on the current page that corresponds to
		* `document.activeElement` or `document.body` if the active element is not
		* available.
		*/
		public activeElement(): Promise<ElementHandle>
		/**
		* Locates the DOM element on the current page that corresponds to
		* `document.activeElement` or `document.body` if the active element is not
		* available.
		*/
		public activeElement(): Promise<ElementHandle \| null>

		/**
		* Navigates to the topmost frame
		*/
		public defaultContent(): Promise<void>
		/**
		* Navigates to the topmost frame
		*/
		public defaultContent(): Promise<void>

		/**
		* Changes the active target to another frame.
		*
		* Accepts either:
		*
		* number: Switch to frame by index in window.frames,
		* string: Switch to frame by frame.name or frame.id, whichever matches first,
		* ElementHandle: Switch to a frame using the supplied ElementHandle of a frame.
		*
		* @param id number \| string \| ElementHandle
		*/
		public frame(id: number \| string \| ElementHandle)
		/**
		* Changes the active target to another frame.
		*
		* Accepts either:
		*
		* number: Switch to frame by index in window.frames,
		* string: Switch to frame by frame.name or frame.id, whichever matches first,
		* ElementHandle: Switch to a frame using the supplied ElementHandle of a frame.
		*
		* @param id number \| string \| ElementHandle
		*/
		public frame(id: number \| string \| ElementHandle)
		}
		@@ -342,180 +336,180 @@
		declare class By {
		/**
		* Locates an element using a CSS (jQuery) style selector
		* @param selector
		*/
		static css(selector: string): Locator
		/**
		* Locates an element using a CSS (jQuery) style selector
		* @param selector
		*/
		static css(selector: string): Locator

		/**
		* Finds an element by ID
		* @param id
		*/
		static id(id: string): Locator
		/**
		* Finds an element by ID
		* @param id
		*/
		static id(id: string): Locator

		/**
		* Recives a function which runs on the page and returns an element or elements.
		* @param func
		*/
		static js(func: () => ElementHandle): Locator
		/**
		* Recives a function which runs on the page and returns an element or elements.
		* @param func
		*/
		static js(func: () => ElementHandle): Locator

		/**
		* Locates a link containing the specified text.
		* @param text
		*/
		static linkText(text: string): Locator
		/**
		* Locates a link containing the specified text.
		* @param text
		*/
		static linkText(text: string): Locator

		/**
		* Locates a link (<a>) containing some of the specified text
		* @param text
		*/
		static partialLinkText(text: string): Locator
		/**
		* Locates a link (<a>) containing some of the specified text
		* @param text
		*/
		static partialLinkText(text: string): Locator

		/**
		* Locates all elements whose `textContent` equals the given
		* substring and is not hidden by CSS.
		*
		* @param {string} text The string to check for in a elements's visible text.
		*/
		static visibleText(text: string): Locator
		/**
		* Locates all elements whose `textContent` equals the given
		* substring and is not hidden by CSS.
		*
		* @param {string} text The string to check for in a elements's visible text.
		*/
		static visibleText(text: string): Locator

		/**
		* Locates all elements whose `textContent` contains the given
		* substring and is not hidden by CSS.
		*
		* @param {string} text The substring to check for in a elements's visible text.
		*/
		static partialVisibleText(text: string): Locator
		/**
		* Locates all elements whose `textContent` contains the given
		* substring and is not hidden by CSS.
		*
		* @param {string} text The substring to check for in a elements's visible text.
		*/
		static partialVisibleText(text: string): Locator

		/**
		* Finds an element containing a specified attribute value
		* @param tagName TagName to scope selection to
		* @param attrName The attribute to search for
		* @param attrValue Optional attribute value to compare
		*/
		static attr(tagName: string, attrName: string, attrValue?: string): Locator
		/**
		* Finds an element containing a specified attribute value
		* @param tagName TagName to scope selection to
		* @param attrName The attribute to search for
		* @param attrValue Optional attribute value to compare
		*/
		static attr(tagName: string, attrName: string, attrValue?: string): Locator

		/**
		* Locates an element using an XPath expression
		* @param path XPath selector
		*/
		static xpath(path: string): Locator
		/**
		* Locates an element using an XPath expression
		* @param path XPath selector
		*/
		static xpath(path: string): Locator
		}

		declare class Until {
		/**
		* Creates a condition that will wait until the input driver is able to switch to the designated frame.
		*
		* The target frame may be specified as:
		* - numeric index into window.frames for the currently selected frame.
		* - ElementHandle, which must references a FRAME or IFRAME element on the current page.
		* - locator which may be used to first locate a FRAME or IFRAME on the current page before attempting to switch to it.
		*
		* Upon successful resolution of this condition, the driver will be left focused on the new frame.
		*/
		static ableToSwitchToFrame(): Condition
		/**
		* Creates a condition that will wait until the input driver is able to switch to the designated frame.
		*
		* The target frame may be specified as:
		* - numeric index into window.frames for the currently selected frame.
		* - ElementHandle, which must references a FRAME or IFRAME element on the current page.
		* - locator which may be used to first locate a FRAME or IFRAME on the current page before attempting to switch to it.
		*
		* Upon successful resolution of this condition, the driver will be left focused on the new frame.
		*/
		static ableToSwitchToFrame(): Condition

		/**
		* Creates a condition that waits for an alert to be opened. Upon success, the returned promise will be fulfilled with the handle for the opened alert
		* @param alertText
		*/
		static alertIsPresent(alertText: string): Condition
		/**
		* Creates a condition that waits for an alert to be opened. Upon success, the returned promise will be fulfilled with the handle for the opened alert
		* @param alertText
		*/
		static alertIsPresent(alertText: string): Condition

		/**
		* Creates a condition that will wait for the given element to be disabled
		* @param selectorOrLocator
		*/
		static elementIsDisabled(locatable: Locatable): Condition
		/**
		* Creates a condition that will wait for the given element to be disabled
		* @param selectorOrLocator
		*/
		static elementIsDisabled(locatable: Locatable): Condition

		/**
		* Creates a condition that will wait for the given element to be enabled
		* @param selectorOrLocator
		*/
		static elementIsEnabled(locatable: Locatable): Condition
		/**
		* Creates a condition that will wait for the given element to be enabled
		* @param selectorOrLocator
		*/
		static elementIsEnabled(locatable: Locatable): Condition

		/**
		* Creates a condition that will wait for the given element to be deselected.
		* @param selectorOrLocator
		*/
		static elementIsSelected(locatable: Locatable): Condition
		/**
		* Creates a condition that will wait for the given element to be deselected.
		* @param selectorOrLocator
		*/
		static elementIsSelected(locatable: Locatable): Condition

		/**
		* Creates a condition that will wait for the given element to be in the DOM, yet not visible to the user
		* @param selectorOrLocator
		*/
		static elementIsNotSelected(locatable: Locatable): Condition
		/**
		* Creates a condition that will wait for the given element to be in the DOM, yet not visible to the user
		* @param selectorOrLocator
		*/
		static elementIsNotSelected(locatable: Locatable): Condition

		/**
		* Creates a condition that will wait for the given element to be selected.
		* @param selectorOrLocator
		*/
		static elementIsVisible(locatable: Locatable): Condition
		/**
		* Creates a condition that will wait for the given element to be selected.
		* @param selectorOrLocator
		*/
		static elementIsVisible(locatable: Locatable): Condition

		/**
		* Creates a condition that will wait for the given element to become visible.
		* @param selectorOrLocator
		*/
		static elementIsNotVisible(locatable: Locatable): Condition
		/**
		* Creates a condition that will wait for the given element to become visible.
		* @param selectorOrLocator
		*/
		static elementIsNotVisible(locatable: Locatable): Condition

		/**
		* Creates a condition which will wait until the element is located on the page.
		*/
		static elementLocated(locatable: Locatable): Condition
		/**
		* Creates a condition which will wait until the element is located on the page.
		*/
		static elementLocated(locatable: Locatable): Condition

		/**
		* Creates a condition which will wait until the element's text content contains
		* the target text.
		*/
		static elementTextContains(locatable: Locatable, text: string): Condition
		/**
		* Creates a condition which will wait until the element's text content contains
		* the target text.
		*/
		static elementTextContains(locatable: Locatable, text: string): Condition

		/**
		* Creates a condition which will wait until the element's text exactly matches the target text,
		* excluding leading and trailing whitespace.
		*/
		static elementTextIs(locatable: Locatable, text: string): Condition
		/**
		* Creates a condition which will wait until the element's text exactly matches the target text,
		* excluding leading and trailing whitespace.
		*/
		static elementTextIs(locatable: Locatable, text: string): Condition

		/**
		* Creates a condition which will wait until the element's text matches the target Regular Expression.
		*/
		static elementTextMatches(locatable: Locatable, regex: RegExp): Condition
		/**
		* Creates a condition which will wait until the element's text matches the target Regular Expression.
		*/
		static elementTextMatches(locatable: Locatable, regex: RegExp): Condition

		/**
		* Creates a condition that will loop until at least one element is found with the given locator.
		*/
		static elementsLocated(selectorOrLocator: Locator \| string): Condition
		/**
		* Creates a condition that will loop until at least one element is found with the given locator.
		*/
		static elementsLocated(selectorOrLocator: Locator \| string): Condition

		/**
		* Creates a condition that will wait for the given element to become stale.
		* An element is considered stale once it is removed from the DOM, or a new page has loaded.
		*/
		static stalenessOf(selectorOrLocator: Locator \| string): Condition
		/**
		* Creates a condition that will wait for the given element to become stale.
		* An element is considered stale once it is removed from the DOM, or a new page has loaded.
		*/
		static stalenessOf(selectorOrLocator: Locator \| string): Condition

		/**
		* Creates a condition which waits until the page title contains the expected text.
		*/
		static titleContains(title: string): Condition
		/**
		* Creates a condition which waits until the page title contains the expected text.
		*/
		static titleContains(title: string): Condition

		/**
		* Creates a condition which waits until the page title exactly matches the expected text.
		*/
		static titleIs(title: string): Condition
		/**
		* Creates a condition which waits until the page title exactly matches the expected text.
		*/
		static titleIs(title: string): Condition

		/**
		* Creates a condition which waits until the page title matches the title `RegExp`.
		*/
		static titleMatches(title: RegExp): Condition
		/**
		* Creates a condition which waits until the page title matches the title `RegExp`.
		*/
		static titleMatches(title: RegExp): Condition

		/**
		* Creates a condition which waits until the page URL contains the expected path.
		*/
		static urlContains(url: string): Condition
		/**
		* Creates a condition which waits until the page URL contains the expected path.
		*/
		static urlContains(url: string): Condition

		/**
		* Creates a condition which waits until the page URL exactly matches the expected URL.
		*/
		static urlIs(url: string): Condition
		/**
		* Creates a condition which waits until the page URL exactly matches the expected URL.
		*/
		static urlIs(url: string): Condition

		/**
		* Creates a condition which waits until the page URL matches the supplied `RegExp`.
		*/
		static urlMatches(url: RegExp): Condition
		/**
		* Creates a condition which waits until the page URL matches the supplied `RegExp`.
		*/
		static urlMatches(url: RegExp): Condition
		}
		@@ -526,65 +520,65 @@
		export enum Key {
		NULL,
		CANCEL, // ^break
		HELP,
		BACK_SPACE,
		TAB,
		CLEAR,
		RETURN,
		ENTER,
		SHIFT,
		CONTROL,
		ALT,
		PAUSE,
		ESCAPE,
		SPACE,
		PAGE_UP,
		PAGE_DOWN,
		END,
		HOME,
		ARROW_LEFT,
		LEFT,
		ARROW_UP,
		UP,
		ARROW_RIGHT,
		RIGHT,
		ARROW_DOWN,
		DOWN,
		INSERT,
		DELETE,
		SEMICOLON,
		EQUALS,
		NULL,
		CANCEL, // ^break
		HELP,
		BACK_SPACE,
		TAB,
		CLEAR,
		RETURN,
		ENTER,
		SHIFT,
		CONTROL,
		ALT,
		PAUSE,
		ESCAPE,
		SPACE,
		PAGE_UP,
		PAGE_DOWN,
		END,
		HOME,
		ARROW_LEFT,
		LEFT,
		ARROW_UP,
		UP,
		ARROW_RIGHT,
		RIGHT,
		ARROW_DOWN,
		DOWN,
		INSERT,
		DELETE,
		SEMICOLON,
		EQUALS,

		NUMPAD0,
		NUMPAD1,
		NUMPAD2,
		NUMPAD3,
		NUMPAD4,
		NUMPAD5,
		NUMPAD6,
		NUMPAD7,
		NUMPAD8,
		NUMPAD9,
		MULTIPLY,
		ADD,
		SEPARATOR,
		SUBTRACT,
		DECIMAL,
		DIVIDE,
		NUMPAD0,
		NUMPAD1,
		NUMPAD2,
		NUMPAD3,
		NUMPAD4,
		NUMPAD5,
		NUMPAD6,
		NUMPAD7,
		NUMPAD8,
		NUMPAD9,
		MULTIPLY,
		ADD,
		SEPARATOR,
		SUBTRACT,
		DECIMAL,
		DIVIDE,

		F1,
		F2,
		F3,
		F4,
		F5,
		F6,
		F7,
		F8,
		F9,
		F10,
		F11,
		F12,
		F1,
		F2,
		F3,
		F4,
		F5,
		F6,
		F7,
		F8,
		F9,
		F10,
		F11,
		F12,

		COMMAND,
		META,
		COMMAND,
		META,
		}
		@@ -594,29 +588,29 @@
		export interface NavigationOptions {
		/**
		* Maximum navigation time in milliseconds, pass 0 to disable timeout.
		* @default 30000
		*/
		timeout?: number
		/**
		* When to consider navigation succeeded.
		* @default load Navigation is consider when the `load` event is fired.
		*/
		waitUntil?: 'load' \| 'domcontentloaded' \| 'networkidle0' \| 'networkidle2'
		/**
		* Maximum navigation time in milliseconds, pass 0 to disable timeout.
		* @default 30000
		*/
		timeout?: number
		/**
		* When to consider navigation succeeded.
		* @default load Navigation is consider when the `load` event is fired.
		*/
		waitUntil?: 'load' \| 'domcontentloaded' \| 'networkidle0' \| 'networkidle2'
		}

		export enum MouseButtons {
		LEFT = 'left',
		RIGHT = 'right',
		MIDDLE = 'middle',
		LEFT = 'left',
		RIGHT = 'right',
		MIDDLE = 'middle',
		}
		export interface ClickOptions {
		/** defaults to left */
		button?: MouseButtons
		/** defaults to 1 */
		clickCount?: number
		/**
		* Time to wait between mousedown and mouseup in milliseconds.
		* Defaults to 0.
		*/
		delay?: number
		/** defaults to left */
		button?: MouseButtons
		/** defaults to 1 */
		clickCount?: number
		/**
		* Time to wait between mousedown and mouseup in milliseconds.
		* Defaults to 0.
		*/
		delay?: number
		}
		@@ -626,40 +620,40 @@
		export interface ScreenshotOptions {
		/**
		* 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.
		*/
		path?: string
		/**
		* The screenshot type.
		* @default png
		*/
		type?: 'jpeg' \| 'png'
		/** The quality of the image, between 0-100. Not applicable to png images. */
		quality?: number
		/**
		* When true, takes a screenshot of the full scrollable page.
		* @default false
		*/
		fullPage?: boolean
		/**
		* An object which specifies clipping region of the page.
		*/
		clip?: BoundingBox
		/**
		* Hides default white background and allows capturing screenshots with transparency.
		* @default false
		*/
		omitBackground?: boolean
		/**
		* 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.
		*/
		path?: string
		/**
		* The screenshot type.
		* @default png
		*/
		type?: 'jpeg' \| 'png'
		/** The quality of the image, between 0-100. Not applicable to png images. */
		quality?: number
		/**
		* When true, takes a screenshot of the full scrollable page.
		* @default false
		*/
		fullPage?: boolean
		/**
		* An object which specifies clipping region of the page.
		*/
		clip?: BoundingBox
		/**
		* Hides default white background and allows capturing screenshots with transparency.
		* @default false
		*/
		omitBackground?: boolean
		}

		export interface BoundingBox {
		/** The x-coordinate of top-left corner. */
		x: number
		/** The y-coordinate of top-left corner. */
		y: number
		/** The width. */
		width: number
		/** The height. */
		height: number
		/** The x-coordinate of top-left corner. */
		x: number
		/** The y-coordinate of top-left corner. */
		y: number
		/** The width. */
		width: number
		/** The height. */
		height: number
		}
		@@ -671,55 +665,55 @@
		export enum Device {
		'blackberryPlayBook' = 'Blackberry PlayBook',
		'blackberryPlayBookLandscape' = 'Blackberry PlayBook landscape',
		'blackBerryZ30' = 'BlackBerry Z30',
		'blackBerryZ30Landscape' = 'BlackBerry Z30 landscape',
		'galaxyNote_3' = 'Galaxy Note 3',
		'galaxyNote_3Landscape' = 'Galaxy Note 3 landscape',
		'galaxyNoteIi' = 'Galaxy Note II',
		'galaxyNoteIiLandscape' = 'Galaxy Note II landscape',
		'galaxySIii' = 'Galaxy S III',
		'galaxySIiiLandscape' = 'Galaxy S III landscape',
		'galaxyS5' = 'Galaxy S5',
		'galaxyS5Landscape' = 'Galaxy S5 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',
		'blackberryPlayBook' = 'Blackberry PlayBook',
		'blackberryPlayBookLandscape' = 'Blackberry PlayBook landscape',
		'blackBerryZ30' = 'BlackBerry Z30',
		'blackBerryZ30Landscape' = 'BlackBerry Z30 landscape',
		'galaxyNote_3' = 'Galaxy Note 3',
		'galaxyNote_3Landscape' = 'Galaxy Note 3 landscape',
		'galaxyNoteIi' = 'Galaxy Note II',
		'galaxyNoteIiLandscape' = 'Galaxy Note II landscape',
		'galaxySIii' = 'Galaxy S III',
		'galaxySIiiLandscape' = 'Galaxy S III landscape',
		'galaxyS5' = 'Galaxy S5',
		'galaxyS5Landscape' = 'Galaxy S5 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',
		}

package.json

		{
		"name": "@flood/chrome",
		"version": "0.1.13",
		"version": "0.1.14",
		"private": false,
		@@ -33,3 +33,14 @@ "description": "Flood Chrome provides an API for scripting Browser Level Load Tests",
		"performance"
		]
		],
		"prettier": {
		"semi": false,
		"singleQuote": true,
		"trailingComma": "all",
		"printWidth": 100,
		"useTabs": true,
		"tabWidth": 2,
		"bracketSpacing": true,
		"jsxBracketSameLine": true,
		"arrowParens": "avoid"
		}
		}

@flood/chrome - npm Package Compare versions

New alerts

Fixed alerts

Worsened metrics