diff --git a/types/cypress/index.d.ts b/types/cypress/index.d.ts index d3fe95c92b..e7f2a59447 100644 --- a/types/cypress/index.d.ts +++ b/types/cypress/index.d.ts @@ -2,6 +2,7 @@ // Project: https://cypress.io // Definitions by: Gert Hengeveld // Mike Woudenberg +// Robbert van Markus // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 @@ -375,6 +376,12 @@ declare namespace Cypress { */ title(options?: Loggable): Chainable; + /** + * @description Trigger an event on a DOM element. + * @see https://docs.cypress.io/api/commands/trigger.html + */ + trigger(eventName: string, position?: PositionType, x?: number, y?: number, options?: TriggerOptions): Chainable; + /** * @see https://on.cypress.io/api/type */ @@ -539,6 +546,16 @@ declare namespace Cypress { onBeforeLoad?(args: any[]): void; onLoad?(args: any[]): void; } + + interface TriggerOptions { + log?: boolean; + force?: boolean; + bubbles?: boolean; + cancable?: boolean; + timeout?: number; + } + + type PositionType = "topLeft" | "top" | "topRight" | "left" | "center" | "right" | "bottomLeft" | "bottom" | "bottomRight"; } declare const cy: Cypress.Chainable;