Adds type definitions for cypress.io

2026-06-28 14:20:12 +00:00 · 2017-05-11 21:13:48 +02:00
parent ac9bfc4eec
commit 7ecb5efeae
4 changed files with 579 additions and 0 deletions
--- a/types/cypress/cypress-tests.ts
+++ b/types/cypress/cypress-tests.ts
@@ -0,0 +1,13 @@
+// Samples taken from the cypress kitchen sink example (https://github.com/cypress-io/cypress-example-kitchensink)
+cy.title().should('include', 'Kitchen Sink');
+
+cy
+  .get('.query-list')
+  .contains('bananas').should('have.class', 'third')
+  .contains(/^b\w+/).should('have.class', 'third')
+  .get('.query-list')
+  .contains('apples').should('have.class', 'first')
+  .get('#querying')
+  .contains('ul', 'oranges').should('have.class', 'query-list')
+  .get('.query-button')
+  .contains('Save Form').should('have.class', 'btn');
--- a/types/cypress/index.d.ts
+++ b/types/cypress/index.d.ts
@@ -0,0 +1,543 @@
+// Type definitions for cypress 0.1
+// Project: https://cypress.io
+// Definitions by: Gert Hengeveld <https://github.com/ghengeveld>
+//                 Mike Woudenberg <https://github.com/mikewoudenberg>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.2
+
+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";
+
+  interface Core {
+    /**
+     * @see https://on.cypress.io/api/config
+     */
+    config(): object;
+    config(key: string): any;
+    config(key: string, value: any): void;
+    config(Object: object): void;
+
+    /**
+     * @see https://on.cypress.io/api/env
+     */
+    env(): object;
+    env(key: string): any;
+    env(key: string, value: any): void;
+    env(Object: object): void;
+
+    /**
+     * @see https://on.cypress.io/api/commands
+     */
+    addChildCommand(name: string, fn: (args: any[]) => void): void;
+    addDualCommand(name: string, fn: (args: any[]) => void): void;
+    addParentCommand(name: string, fn: (args: any[]) => void): void;
+
+    _: any;
+    $: any;
+    minimatch: any;
+    moment: any;
+    Blob: any;
+    Promise: any;
+
+    /**
+     * @see https://on.cypress.io/api/cookies
+     */
+    Cookies: {
+      debug(enabled: boolean, options?: DebugOptions): void;
+      preserveOnce(...names: string[]): void;
+      defaults(options: CookieDefaults): void;
+    };
+
+    /**
+     * @see https://on.cypress.io/api/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: (args: 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;
+
+    /**
+     * @see https://on.cypress.io/api/document
+     */
+    document(options?: Loggable): Chainable;
+
+    /**
+     * @see https://on.cypress.io/api/each
+     */
+    each(fn: (args: 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?
+
+    /**
+     * @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: (args: any[]) => void | 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: (args: 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[]) => void): Chainable;
+
+    /**
+     * @see https://on.cypress.io/api/submit
+     */
+    submit(options?: Loggable): Chainable;
+
+    /**
+     * @see https://on.cypress.io/api/then
+     */
+    then(fn: (args: any[]) => void): Chainable;
+
+    /**
+     * @see https://on.cypress.io/api/title
+     */
+    title(options?: Loggable): Chainable;
+
+    /**
+     * @see https://on.cypress.io/api/type
+     */
+    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;
+
+    /**
+     * @see https://on.cypress.io/api/visit
+     */
+    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;
+
+    /**
+     * @see https://on.cypress.io/api/window
+     */
+    window(options?: Loggable): Chainable;
+
+    /**
+     * @see https://on.cypress.io/api/within
+     */
+    within(fn: (args: any[]) => void): Chainable;
+    within(options: Loggable, fn: (args: 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 | ((args: any[]) => void);
+  }
+
+  interface Loggable {
+    log?: boolean;
+  }
+
+  interface Timeoutable {
+    timeout?: number;
+  }
+
+  interface LoggableTimeoutable extends Loggable, Timeoutable {}
+
+  interface BlurOptions extends Loggable {
+    force?: boolean;
+  }
+
+  interface CheckOptions extends Loggable, Timeoutable {
+    interval?: number;
+    force?: boolean;
+  }
+
+  interface ClearOptions extends Loggable, Timeoutable {
+    force?: boolean;
+    interval?: number;
+  }
+
+  interface ClickOptions extends Loggable, Timeoutable {
+    force?: boolean;
+    multiple?: boolean;
+    interval?: number;
+  }
+
+  interface ExecOptions extends Loggable, Timeoutable {
+    failOnNonZeroExit?: boolean;
+    env?: object;
+  }
+
+  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;
+  }
+
+  interface TypeOptions extends Loggable, Timeoutable {
+    delay?: number;
+    force?: boolean;
+    release?: boolean;
+    interval?: number;
+  }
+
+  interface VisitOptions extends Loggable, Timeoutable {
+    onBeforeLoad?(args: any[]): void;
+    onLoad?(args: any[]): void;
+  }
+}
+
+declare const cy: Cypress.Chainable;
--- a/types/cypress/tsconfig.json
+++ b/types/cypress/tsconfig.json
@@ -0,0 +1,22 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "cypress-tests.ts"
+    ]
+}
--- a/types/cypress/tslint.json
+++ b/types/cypress/tslint.json
@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }