mirror of
https://github.com/cypress-io/cypress.git
synced 2026-05-02 21:10:47 -05:00
chore: Add dtslint and Cypress static types (#1044)
* chore: Add dtslint and Cypress static types * chore: Fix types location for cli build * chore: Removed api from api command paths * chore: Remove semicolons from type definitions * chore: Removed semicolons not caught by tslint * chore: Add type tests
This commit is contained in:
Nicholas Boll
committed by
Brian Mann
Brian Mann
parent
4d41d3d641
commit
6db7a83125
Vendored
-918
@@ -1,918 +0,0 @@
|
||||
// Type definitions for Cypress test runner
|
||||
// Project: https://www.cypress.io
|
||||
// GitHub: https://github.com/cypress-io/cypress
|
||||
// Definitions by: Gert Hengeveld <https://github.com/ghengeveld>
|
||||
// Mike Woudenberg <https://github.com/mikewoudenberg>
|
||||
// Robbert van Markus <https://github.com/rvanmarkus>
|
||||
// TypeScript Version: 2.x
|
||||
// Updated by the Cypress team: https://www.cypress.io/about/
|
||||
|
||||
declare namespace Cypress {
|
||||
type FileContents = string | any[] | object;
|
||||
type HistoryDirection = "back" | "forward";
|
||||
type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "OPTIONS" | "HEAD" | "TRACE" | "CONNECT";
|
||||
type RequestBody = string | object;
|
||||
type ViewportOrientation = "portrait" | "landscape";
|
||||
type PrevSubject = "optional" | "element" | "document" | "window";
|
||||
type CommandOptions = {prevSubject: boolean | PrevSubject | PrevSubject[]};
|
||||
|
||||
/**
|
||||
* Several libraries are bundled with Cypress by default.
|
||||
*
|
||||
* @interface Cypress
|
||||
* @see https://on.cypress.io/api
|
||||
*/
|
||||
interface Cypress {
|
||||
/**
|
||||
* Lodash library
|
||||
*
|
||||
* @type {*}
|
||||
* @memberof Cypress
|
||||
* @see https://on.cypress.io/_
|
||||
* @example Cypress._.keys(obj)
|
||||
*/
|
||||
_: any,
|
||||
/**
|
||||
* jQuery library
|
||||
*
|
||||
* @type {*}
|
||||
* @memberof Cypress
|
||||
* @see https://on.cypress.io/$
|
||||
* @example Cypress.$('p')
|
||||
*/
|
||||
$: any,
|
||||
/**
|
||||
* Cypress automatically includes a Blob library and exposes it as Cypress.Blob.
|
||||
*
|
||||
* @type {*}
|
||||
* @memberof Cypress
|
||||
* @see https://on.cypress.io/blob
|
||||
* @see https://github.com/nolanlawson/blob-util
|
||||
* @example Cypress.Blob.method()
|
||||
*/
|
||||
Blob: any,
|
||||
/**
|
||||
* Cypress automatically includes minimatch and exposes it as Cypress.minimatch.
|
||||
*
|
||||
* @type {Function}
|
||||
* @memberof Cypress
|
||||
* @see https://on.cypress.io/minimatch
|
||||
*/
|
||||
minimatch: Function,
|
||||
/**
|
||||
* Cypress automatically includes moment.js and exposes it as Cypress.moment.
|
||||
*
|
||||
* @type {Function}
|
||||
* @memberof Cypress
|
||||
* @see https://on.cypress.io/moment
|
||||
* @see http://momentjs.com/
|
||||
* @example const todaysDate = Cypress.moment().format("MMM DD, YYYY")
|
||||
*/
|
||||
moment: Function,
|
||||
/**
|
||||
* Cypress automatically includes Bluebird and exposes it as Cypress.Promise.
|
||||
*
|
||||
* @type {*}
|
||||
* @memberof Cypress
|
||||
* @see https://on.cypress.io/promise
|
||||
* @see https://github.com/petkaantonov/bluebird
|
||||
* @example new Cypress.Promise((resolve, reject) => { ... })
|
||||
*/
|
||||
Promise: any,
|
||||
/**
|
||||
* Cypress version string. i.e. "1.1.2"
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof Cypress
|
||||
*/
|
||||
version: string,
|
||||
|
||||
/**
|
||||
* OS platform name, from Node `os.platform()`
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof Cypress
|
||||
* @see https://nodejs.org/api/os.html#os_os_platform
|
||||
* @example Cypress.platform // "darwin"
|
||||
*/
|
||||
platform: string,
|
||||
|
||||
/**
|
||||
* CPU architecture, from Node `os.arch()`
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof Cypress
|
||||
* @see https://nodejs.org/api/os.html#os_os_arch
|
||||
* @example Cypress.arch // "x64"
|
||||
*/
|
||||
arch: string
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/config
|
||||
*/
|
||||
config(): object;
|
||||
config(key: string): any;
|
||||
config(key: string, value: any): void;
|
||||
config(Object: object): void;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/env
|
||||
*/
|
||||
env(): object;
|
||||
env(key: string): any;
|
||||
env(key: string, value: any): void;
|
||||
env(Object: object): void;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/commands
|
||||
*/
|
||||
Commands: {
|
||||
add(name: string, fn: (...args: any[]) => void): void;
|
||||
add(name: string, options: CommandOptions, fn: (...args: any[]) => void): void;
|
||||
overwrite(name: string, fn: (...args: any[]) => void): void;
|
||||
overwrite(name: string, options: CommandOptions, fn: (...args: any[]) => void): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/cookies
|
||||
*/
|
||||
Cookies: {
|
||||
debug(enabled: boolean, options?: DebugOptions): void;
|
||||
preserveOnce(...names: string[]): void;
|
||||
defaults(options: CookieDefaults): void;
|
||||
};
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/dom
|
||||
*/
|
||||
dom: {
|
||||
isHidden(element: object): boolean;
|
||||
};
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/api-server
|
||||
*/
|
||||
Server: {
|
||||
defaults(options: ServerOptions): void;
|
||||
};
|
||||
}
|
||||
|
||||
interface Chainable {
|
||||
/**
|
||||
* @see https://on.cypress.io/api/and
|
||||
*/
|
||||
and(chainers: string, value?: any): Chainable;
|
||||
and(chainers: string, method: string, value: any): Chainable;
|
||||
and(fn: (currentSubject?: any) => void): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/as
|
||||
*/
|
||||
as(alias: string): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/blur
|
||||
*/
|
||||
blur(options?: BlurOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/check
|
||||
*/
|
||||
check(options?: CheckOptions): Chainable;
|
||||
check(value: string | string[]): Chainable; // no options
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/children
|
||||
*/
|
||||
children(options?: LoggableTimeoutable): Chainable;
|
||||
children(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/clear
|
||||
*/
|
||||
clear(options?: ClearOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/clearcookie
|
||||
*/
|
||||
clearCookie(name: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/clearcookies
|
||||
*/
|
||||
clearCookies(options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/clearlocalstorage
|
||||
*/
|
||||
clearLocalStorage(key?: string): Chainable;
|
||||
clearLocalStorage(re: RegExp): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/click
|
||||
*/
|
||||
click(options?: ClickOptions): Chainable;
|
||||
click(position: string, options?: ClickOptions): Chainable;
|
||||
click(x: number, y: number, options?: ClickOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/closest
|
||||
*/
|
||||
closest(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/contains
|
||||
*/
|
||||
contains(text: string, options?: LoggableTimeoutable): Chainable;
|
||||
contains(num: number | RegExp): Chainable;
|
||||
contains(selector: string, text: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/dblclick
|
||||
*/
|
||||
dblclick(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/debug
|
||||
*/
|
||||
debug(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* Get the window.document of the page that is currently active.
|
||||
*
|
||||
* @param {Loggable} [options]
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/document
|
||||
* @example
|
||||
* cy.document()
|
||||
* .its('contentType')
|
||||
* .should('eq', 'text/html')
|
||||
*/
|
||||
document(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/each
|
||||
*/
|
||||
each(fn: (element?: any, index?: number, $list?: any) => void): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/end
|
||||
*/
|
||||
end(): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/eq
|
||||
*/
|
||||
eq(index: number, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/exec
|
||||
*/
|
||||
exec(command: string, options?: ExecOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/filter
|
||||
*/
|
||||
filter(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/find
|
||||
*/
|
||||
find(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/first
|
||||
*/
|
||||
first(options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/fixture
|
||||
*/
|
||||
fixture(path: string, options?: Timeoutable): Chainable; // no log?
|
||||
fixture(path: string, encoding: string, options?: Timeoutable): Chainable; // no log?
|
||||
|
||||
/**
|
||||
* Get the DOM element that is currently focused.
|
||||
*
|
||||
* @param {Loggable} [options]
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/focus
|
||||
*/
|
||||
focus(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/focused
|
||||
*/
|
||||
focused(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/get
|
||||
*/
|
||||
get(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
get(alias: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/getcookie
|
||||
*/
|
||||
getCookie(name: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/getcookies
|
||||
*/
|
||||
getCookies(options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/go
|
||||
*/
|
||||
go(direction: HistoryDirection | number, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/hash
|
||||
*/
|
||||
hash(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/invoke
|
||||
*/
|
||||
invoke(functionName: string, ...args: any[]): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/its
|
||||
*/
|
||||
its(propertyName: string): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/last
|
||||
*/
|
||||
last(options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/location
|
||||
*/
|
||||
location(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/log
|
||||
*/
|
||||
log(message: string, args: any): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/next
|
||||
*/
|
||||
next(options?: LoggableTimeoutable): Chainable;
|
||||
next(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/not
|
||||
*/
|
||||
not(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/parent
|
||||
*/
|
||||
parent(options?: LoggableTimeoutable): Chainable;
|
||||
parent(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/parents
|
||||
*/
|
||||
parents(options?: LoggableTimeoutable): Chainable;
|
||||
parents(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/pause
|
||||
*/
|
||||
pause(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/prev
|
||||
*/
|
||||
prev(options?: LoggableTimeoutable): Chainable;
|
||||
prev(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/readfile
|
||||
*/
|
||||
readFile(filePath: string, options?: Timeoutable): Chainable; // no log?
|
||||
readFile(filePath: string, encoding: string, options?: Timeoutable): Chainable; // no log?
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/reload
|
||||
*/
|
||||
reload(options?: LoggableTimeoutable): Chainable;
|
||||
reload(forceReload: boolean): Chainable; // no options?
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/request
|
||||
*/
|
||||
request(url: string, body?: RequestBody): Chainable;
|
||||
request(method: HttpMethod, url: string, body?: RequestBody): Chainable;
|
||||
request(options: RequestOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/root
|
||||
*/
|
||||
root(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/route
|
||||
*/
|
||||
route(url: string, response?: any): Chainable;
|
||||
route(method: string, url: string, response?: any): Chainable;
|
||||
route(fn: () => RouteOptions | RouteOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/screenshot
|
||||
*/
|
||||
screenshot(options?: LoggableTimeoutable): Chainable;
|
||||
screenshot(fileName: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/select
|
||||
*/
|
||||
select(text: string | string[], options?: SelectOptions): Chainable;
|
||||
select(value: string | string[], options?: SelectOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/server
|
||||
*/
|
||||
server(options?: ServerOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/setcookie
|
||||
*/
|
||||
setCookie(name: string, value: string, options?: SetCookieOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/should
|
||||
*/
|
||||
should(chainers: string, value?: any): Chainable;
|
||||
should(chainers: string, method: string, value: any): Chainable;
|
||||
should(fn: (currentSubject?: any) => void): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/siblings
|
||||
*/
|
||||
siblings(options?: LoggableTimeoutable): Chainable;
|
||||
siblings(selector: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/spread
|
||||
*/
|
||||
spread(fn: (...args: any[]) => any): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/submit
|
||||
*/
|
||||
submit(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/then
|
||||
*/
|
||||
then(fn: (currentSubject: any) => any, options?: Timeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/title
|
||||
*/
|
||||
title(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @description Trigger an event on a DOM element.
|
||||
* @param {string} eventName
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/trigger
|
||||
* @example:
|
||||
* cy.get('a').trigger('mousedown')
|
||||
*/
|
||||
trigger(eventName: string): Chainable;
|
||||
/**
|
||||
* @description Trigger an event on a DOM element at a named position.
|
||||
* @param {string} eventName
|
||||
* @param {PositionType} position
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/trigger
|
||||
*/
|
||||
trigger(eventName: string, position: PositionType): Chainable;
|
||||
/**
|
||||
* @description Trigger an event on a DOM element with options.
|
||||
* @param {string} eventName
|
||||
* @param {TriggerOptions} options
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/trigger
|
||||
*/
|
||||
trigger(eventName: string, options: TriggerOptions): Chainable;
|
||||
/**
|
||||
* @description Trigger an event on a DOM element at specific coordinates (from top left corner)
|
||||
* @param {string} eventName
|
||||
* @param {number} x The distance in pixels from element’s left to trigger the event.
|
||||
* @param {number} y The distance in pixels from element’s top to trigger the event.
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/trigger
|
||||
*/
|
||||
trigger(eventName: string, x: number, y: number): Chainable;
|
||||
/**
|
||||
* @description Trigger an event on a DOM element
|
||||
*
|
||||
* @param {string} eventName
|
||||
* @param {PositionType} position
|
||||
* @param {TriggerOptions} options
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/trigger
|
||||
*/
|
||||
trigger(eventName: string, position: PositionType, options: TriggerOptions): Chainable;
|
||||
/**
|
||||
* @description Trigger an event on a DOM element
|
||||
*
|
||||
* @param {string} eventName
|
||||
* @param {number} x The distance in pixels from element’s left to trigger the event.
|
||||
* @param {number} y The distance in pixels from element’s top to trigger the event.
|
||||
* @param {TriggerOptions} options
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/trigger
|
||||
*/
|
||||
trigger(eventName: string, x: number, y: number, options: TriggerOptions): Chainable;
|
||||
|
||||
/**
|
||||
* Type into a DOM element.
|
||||
*
|
||||
* @param {string} text The text to be typed into the DOM element.
|
||||
* @param {TypeOptions} [options]
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/type
|
||||
* @example
|
||||
*
|
||||
* cy.get('input').type('Hello, World')
|
||||
* // Type 'Hello, World' into the 'input'
|
||||
*/
|
||||
type(text: string, options?: TypeOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/uncheck
|
||||
*/
|
||||
uncheck(options?: CheckOptions): Chainable;
|
||||
uncheck(values: string[]): Chainable; // no options? missing single value variant
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/url
|
||||
*/
|
||||
url(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/viewport
|
||||
*/
|
||||
viewport(width: number, height: number, options?: Loggable): Chainable;
|
||||
viewport(preset: string, orientation: ViewportOrientation, options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* Visit the given url
|
||||
*
|
||||
* @param {string} url The URL to visit. If relative uses `baseUrl`
|
||||
* @param {VisitOptions} [options] Pass in an options object to change the default behavior of `cy.visit()`
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/visit
|
||||
* @example
|
||||
* cy.visit('http://localhost:3000')
|
||||
*/
|
||||
visit(url: string, options?: VisitOptions): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/wait
|
||||
*/
|
||||
wait(ms: number | string[]): Chainable; // no options?
|
||||
wait(alias: string, options?: LoggableTimeoutable): Chainable;
|
||||
|
||||
/**
|
||||
* Get the window object of the page that is currently active.
|
||||
*
|
||||
* @param {Loggable} [options]
|
||||
* @returns {Chainable}
|
||||
* @memberof Chainable
|
||||
* @see https://on.cypress.io/api/window
|
||||
* @example
|
||||
* cy.visit('http://localhost:8080/app')
|
||||
* cy.window().then(function(win){
|
||||
* // win is the remote window
|
||||
* // of the page at: http://localhost:8080/app
|
||||
* })
|
||||
*/
|
||||
window(options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/within
|
||||
*/
|
||||
within(fn: (currentSubject?: any) => void): Chainable;
|
||||
within(options: Loggable, fn: (currentSubject?: any) => void): Chainable; // inconsistent argument order
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/wrap
|
||||
*/
|
||||
wrap(Object: object, options?: Loggable): Chainable;
|
||||
|
||||
/**
|
||||
* @see https://on.cypress.io/api/writefile
|
||||
*/
|
||||
writeFile(filePath: string, contents: FileContents, options?: Timeoutable): Chainable;
|
||||
writeFile(filePath: string, contents: FileContents, encoding: string, options?: Timeoutable): Chainable;
|
||||
}
|
||||
|
||||
interface DebugOptions {
|
||||
verbose?: boolean;
|
||||
}
|
||||
|
||||
interface CookieDefaults {
|
||||
whitelist?: string | string[] | RegExp | ((cookie: any) => boolean);
|
||||
}
|
||||
|
||||
/**
|
||||
* Options that control how a command is logged in the Reporter
|
||||
*
|
||||
* @interface Loggable
|
||||
*/
|
||||
interface Loggable {
|
||||
/**
|
||||
* Displays the command in the Command Log
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default true
|
||||
* @memberof Loggable
|
||||
*/
|
||||
log?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options that control how long Test Runner is waiting for command to succeed
|
||||
*
|
||||
* @interface Timeoutable
|
||||
*/
|
||||
interface Timeoutable {
|
||||
/**
|
||||
* Time to wait (ms)
|
||||
*
|
||||
* @type {number} milliseconds
|
||||
* @default defaultCommandTimeout
|
||||
* @memberof Timeoutable
|
||||
* @see https://docs.cypress.io/guides/references/configuration.html#Timeouts
|
||||
*/
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Union of Loggable and Timeoutable interfaces
|
||||
*
|
||||
* @interface LoggableTimeoutable
|
||||
* @extends {Loggable}
|
||||
* @extends {Timeoutable}
|
||||
*/
|
||||
interface LoggableTimeoutable extends Loggable, Timeoutable { }
|
||||
|
||||
/**
|
||||
* Options to force an event, skipping Actionability check
|
||||
* @see https://docs.cypress.io/guides/core-concepts/interacting-with-elements.html#Actionability
|
||||
* @interface Forceable
|
||||
*/
|
||||
interface Forceable {
|
||||
/**
|
||||
* Forces the action, disables waiting for actionability
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default false
|
||||
* @memberof Forceable
|
||||
*/
|
||||
force?: boolean;
|
||||
}
|
||||
|
||||
interface BlurOptions extends Loggable, Forceable { }
|
||||
|
||||
interface CheckOptions extends LoggableTimeoutable, Forceable {
|
||||
interval?: number;
|
||||
}
|
||||
|
||||
interface ClearOptions extends LoggableTimeoutable, Forceable {
|
||||
interval?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Object to change the default behavior of .click().
|
||||
*
|
||||
* @interface ClickOptions
|
||||
* @extends {Loggable}
|
||||
* @extends {Timeoutable}
|
||||
*/
|
||||
interface ClickOptions extends Loggable, Timeoutable {
|
||||
/**
|
||||
* Forces the action, disables waiting for actionability
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default false
|
||||
* @memberof ClickOptions
|
||||
*/
|
||||
force?: boolean;
|
||||
/**
|
||||
* Serially click multiple elements
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default false
|
||||
* @memberof ClickOptions
|
||||
*/
|
||||
multiple?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options object to change the default behavior of cy.exec().
|
||||
*
|
||||
* @interface ExecOptions
|
||||
* @extends {Loggable}
|
||||
* @extends {Timeoutable}
|
||||
*/
|
||||
interface ExecOptions extends Loggable, Timeoutable {
|
||||
/**
|
||||
* Whether to fail if the command exits with a non-zero code
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default true
|
||||
* @memberof ExecOptions
|
||||
*/
|
||||
failOnNonZeroExit?: boolean;
|
||||
/**
|
||||
* Object of environment variables to set before the command executes
|
||||
* (e.g. {USERNAME: 'johndoe'}). Will be merged with existing
|
||||
* system environment variables
|
||||
*
|
||||
* @type {object}
|
||||
* @default {}
|
||||
* @memberof ExecOptions
|
||||
*/
|
||||
env?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @interface RequestOptions
|
||||
* @extends {Loggable}
|
||||
* @extends {Timeoutable}
|
||||
*/
|
||||
interface RequestOptions extends Loggable, Timeoutable {
|
||||
auth?: object;
|
||||
body?: RequestBody;
|
||||
failOnStatusCode?: boolean;
|
||||
followRedirect?: boolean;
|
||||
form?: boolean;
|
||||
gzip?: boolean;
|
||||
headers?: object;
|
||||
method?: HttpMethod;
|
||||
qs?: string;
|
||||
url: string;
|
||||
}
|
||||
|
||||
interface RouteOptions {
|
||||
method?: HttpMethod;
|
||||
url?: string | RegExp;
|
||||
response?: any;
|
||||
status?: number;
|
||||
delay?: number;
|
||||
headers?: object;
|
||||
force404?: boolean;
|
||||
onRequest?(...args: any[]): void;
|
||||
onResponse?(...args: any[]): void;
|
||||
onAbort?(...args: any[]): void;
|
||||
}
|
||||
|
||||
interface SelectOptions extends Loggable, Timeoutable {
|
||||
force?: boolean;
|
||||
interval?: number;
|
||||
}
|
||||
|
||||
interface ServerOptions {
|
||||
delay?: number;
|
||||
method?: HttpMethod;
|
||||
status?: number;
|
||||
headers?: object;
|
||||
response?: any;
|
||||
onRequest?(...args: any[]): void;
|
||||
onResponse?(...args: any[]): void;
|
||||
onAbort?(...args: any[]): void;
|
||||
enable?: boolean;
|
||||
force404?: boolean;
|
||||
urlMatchingOptions?: object;
|
||||
whitelist?(...args: any[]): void;
|
||||
}
|
||||
|
||||
interface SetCookieOptions extends Loggable, Timeoutable {
|
||||
path?: string;
|
||||
domain?: string;
|
||||
secure?: boolean;
|
||||
httpOnly?: boolean;
|
||||
expiry?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options that control `cy.type` command
|
||||
*
|
||||
* @interface TypeOptions
|
||||
* @extends {Loggable}
|
||||
* @extends {Timeoutable}
|
||||
* @see https://on.cypress.io/api/type
|
||||
*/
|
||||
interface TypeOptions extends Loggable, Timeoutable {
|
||||
/**
|
||||
* Delay after each keypress (ms)
|
||||
*
|
||||
* @type {number}
|
||||
* @default 10
|
||||
* @memberof TypeOptions
|
||||
*/
|
||||
delay?: number;
|
||||
/**
|
||||
* Forces the action, disables waiting for actionability
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default false
|
||||
* @memberof TypeOptions
|
||||
*/
|
||||
force?: boolean;
|
||||
/**
|
||||
* Keep a modifier activated between commands
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default true
|
||||
* @memberof TypeOptions
|
||||
*/
|
||||
release?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Visit website options
|
||||
*
|
||||
* @interface VisitOptions
|
||||
* @extends {Loggable}
|
||||
* @extends {Timeoutable}
|
||||
* @see https://on.cypress.io/visit
|
||||
*/
|
||||
interface VisitOptions extends Loggable, Timeoutable {
|
||||
/**
|
||||
* Called before your page has loaded all of its resources.
|
||||
*
|
||||
* @param {Window} contentWindow the remote page's window object
|
||||
* @memberof VisitOptions
|
||||
*/
|
||||
onBeforeLoad?(win: Window): void;
|
||||
|
||||
/**
|
||||
* Called once your page has fired its load event.
|
||||
*
|
||||
* @param {Window} contentWindow the remote page's window object
|
||||
* @memberof VisitOptions
|
||||
*/
|
||||
onLoad?(win: Window): void;
|
||||
|
||||
/**
|
||||
* Whether to fail on response codes other than 2xx and 3xx
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default {true}
|
||||
* @memberof VisitOptions
|
||||
*/
|
||||
failOnStatusCode?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options to change the default behavior of .trigger()
|
||||
*
|
||||
* @interface TriggerOptions
|
||||
*/
|
||||
interface TriggerOptions extends LoggableTimeoutable, Forceable {
|
||||
/**
|
||||
* Whether the event bubbles
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default true
|
||||
* @memberof TriggerOptions
|
||||
*/
|
||||
bubbles?: boolean;
|
||||
/**
|
||||
* Whether the event is cancelable
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default true
|
||||
* @memberof TriggerOptions
|
||||
*/
|
||||
cancable?: boolean;
|
||||
}
|
||||
|
||||
type PositionType = "topLeft" | "top" | "topRight" | "left" | "center" | "right" | "bottomLeft" | "bottom" | "bottomRight";
|
||||
}
|
||||
|
||||
// global variables added by Cypress when it runs
|
||||
declare const cy: Cypress.Chainable;
|
||||
declare const Cypress: Cypress.Cypress;
|
||||
+11
-2
@@ -11,20 +11,28 @@
|
||||
},
|
||||
"scripts": {
|
||||
"test": "npm run test-unit",
|
||||
"test-unit": "bin-up mocha --reporter mocha-multi-reporters --reporter-options configFile=../mocha-reporter-config.json",
|
||||
"test-unit": "npm run dtslint && bin-up mocha --reporter mocha-multi-reporters --reporter-options configFile=../mocha-reporter-config.json",
|
||||
"test-watch": "bin-up mocha --watch",
|
||||
"test-dependencies": "bin-up deps-ok && dependency-check . --no-dev",
|
||||
"test-debug": "node --inspect --debug-brk $(bin-up _mocha)",
|
||||
"lint": "bin-up eslint --fix *.js bin/* lib/*.js lib/**/*.js test/*.js test/**/*.js",
|
||||
"dtslint": "dtslint types",
|
||||
"prebuild": "npm run test-dependencies && node ./scripts/start-build.js",
|
||||
"build": "node ./scripts/build.js",
|
||||
"prerelease": "npm run build",
|
||||
"release": "cd build && releaser --no-node --no-changelog",
|
||||
"size": "t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";"
|
||||
},
|
||||
"types": "types",
|
||||
"dependencies": {
|
||||
"@cypress/listr-verbose-renderer": "0.4.1",
|
||||
"@cypress/xvfb": "1.0.4",
|
||||
"@types/blob-util": "1.3.3",
|
||||
"@types/bluebird": "3.5.18",
|
||||
"@types/jquery": "3.2.16",
|
||||
"@types/lodash": "4.14.87",
|
||||
"@types/minimatch": "3.0.1",
|
||||
"@types/sinon": "4.0.0",
|
||||
"bluebird": "3.5.0",
|
||||
"chalk": "2.1.0",
|
||||
"check-more-types": "2.24.0",
|
||||
@@ -60,6 +68,7 @@
|
||||
"chai-string": "1.4.0",
|
||||
"clear-module": "^2.1.0",
|
||||
"dependency-check": "^2.8.0",
|
||||
"dtslint": "0.2.0",
|
||||
"execa-wrap": "1.1.0",
|
||||
"nock": "^9.0.9",
|
||||
"shelljs": "0.7.8",
|
||||
@@ -71,6 +80,6 @@
|
||||
"bin",
|
||||
"lib",
|
||||
"index.js",
|
||||
"index.d.ts"
|
||||
"types/*.d.ts"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -33,7 +33,7 @@ function preparePackageForNpmRelease (json) {
|
||||
bugs,
|
||||
repository,
|
||||
engines,
|
||||
types: 'index.d.ts', // typescript types
|
||||
types: 'types', // typescript types
|
||||
scripts: {
|
||||
postinstall: 'node index.js --exec install',
|
||||
size: 't=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";',
|
||||
|
||||
@@ -7,10 +7,11 @@ shell.set('-e') // any error is fatal
|
||||
|
||||
shell.rm('-rf', 'build')
|
||||
shell.mkdir('-p', 'build/bin')
|
||||
shell.mkdir('-p', 'build/types')
|
||||
shell.cp('bin/cypress', 'build/bin/cypress')
|
||||
shell.cp('NPM_README.md', 'build/README.md')
|
||||
shell.cp('.release.json', 'build/.release.json')
|
||||
shell.cp('index.d.ts', 'build/index.d.ts')
|
||||
shell.cp('-R', 'types/*.ts', 'build/types/')
|
||||
|
||||
shell.exec('babel lib -d build/lib')
|
||||
shell.exec('babel index.js -o build/index.js')
|
||||
|
||||
Vendored
+13
@@ -0,0 +1,13 @@
|
||||
// Shim definition to export a namespace. Cypress is actually a global module
|
||||
// so import/export isn't allowed there. We import here and define a global module
|
||||
// so that Cypress can get and use the Blob type
|
||||
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import * as blobUtil from 'blob-util'
|
||||
|
||||
export = BlobUtil
|
||||
export as namespace BlobUtil
|
||||
|
||||
declare namespace BlobUtil {
|
||||
type BlobUtilStatic = typeof blobUtil
|
||||
}
|
||||
Vendored
+11
@@ -0,0 +1,11 @@
|
||||
// Shim definition to export a namespace. Cypress is actually a global module
|
||||
// so import/export isn't allowed there. We import here and define a global module
|
||||
// so that Cypress can get and use the Blob type
|
||||
import * as BluebirdStatic from 'bluebird'
|
||||
|
||||
export = Bluebird
|
||||
export as namespace Bluebird
|
||||
|
||||
declare namespace Bluebird {
|
||||
type BluebirdStatic = typeof BluebirdStatic
|
||||
}
|
||||
Vendored
+1094
File diff suppressed because it is too large
Load Diff
Vendored
+12
@@ -0,0 +1,12 @@
|
||||
// Shim definition to export a namespace. Cypress is actually a global module
|
||||
// so import/export isn't allowed there. We import here and define a global module
|
||||
// so that Cypress can get and use the Blob type
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import * as mimimatch from 'minimatch'
|
||||
|
||||
export = Mimimatch
|
||||
export as namespace Mimimatch
|
||||
|
||||
declare namespace Mimimatch {
|
||||
type MimimatchStatic = mimimatch.IMinimatchStatic
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
namespace CypressLodashTests {
|
||||
Cypress._ // $ExpectType LoDashStatic
|
||||
Cypress._.each([1], item => {
|
||||
item // $ExpectType number
|
||||
})
|
||||
}
|
||||
|
||||
namespace CypressJqueryTests {
|
||||
Cypress.$ // $ExpectType JQueryStatic<HTMLElement>
|
||||
Cypress.$('selector') // $ExpectType JQuery<HTMLElement>
|
||||
Cypress.$('selector').click() // $ExpectType JQuery<HTMLElement>
|
||||
}
|
||||
|
||||
namespace CypressConfigTests {
|
||||
// getters
|
||||
Cypress.config('baseUrl') // $ExpectType string | null
|
||||
Cypress.config().baseUrl // $ExpectType string | null
|
||||
|
||||
// setters
|
||||
Cypress.config('baseUrl', '.') // $ExpectType void
|
||||
Cypress.config('baseUrl', null) // $ExpectType void
|
||||
Cypress.config({ baseUrl: '.', }) // $ExpectType void
|
||||
}
|
||||
|
||||
Cypress.moment()
|
||||
|
||||
namespace CypressEnvTests {
|
||||
// Just making sure these are valid - no real type safety
|
||||
Cypress.env('foo')
|
||||
Cypress.env('foo', 'bar')
|
||||
Cypress.env().foo
|
||||
Cypress.env({
|
||||
foo: 'bar'
|
||||
})
|
||||
}
|
||||
|
||||
namespace CypressCommandsTests {
|
||||
Cypress.Commands.add('newCommand', () => {
|
||||
return
|
||||
})
|
||||
Cypress.Commands.add('newCommand', { prevSubject: true }, () => {
|
||||
return
|
||||
})
|
||||
Cypress.Commands.overwrite('newCommand', () => {
|
||||
return
|
||||
})
|
||||
Cypress.Commands.overwrite('newCommand', { prevSubject: true }, () => {
|
||||
return
|
||||
})
|
||||
}
|
||||
|
||||
namespace CypressLogsTest {
|
||||
Cypress.log({
|
||||
$el: 'foo',
|
||||
name: 'MyCommand',
|
||||
displayName: 'My Command',
|
||||
message: ['foo', 'bar'],
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"dom",
|
||||
"es6"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"strictFunctionTypes": true,
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"include": [
|
||||
"**/*.ts"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"extends": "dtslint/dtslint.json",
|
||||
"rules": {
|
||||
"semicolon": [true, "never"],
|
||||
"no-namespace": false,
|
||||
"max-line-length": false,
|
||||
"void-return": false,
|
||||
"no-redundant-jsdoc": false,
|
||||
"unified-signatures": false,
|
||||
"only-arrow-functions": false,
|
||||
"no-unnecessary-generics": false,
|
||||
"export-just-namespace": false
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user