diff --git a/README.md b/README.md index da7ca1a..5dad939 100644 --- a/README.md +++ b/README.md @@ -254,6 +254,7 @@ cy.realSwipe(direction, options); Options: - `Optional` **length**: undefined \| number **`default`** 10 +- `Optional` **step**: undefined \| number **`default`** 10 - `Optional` **x**: undefined \| number ([more about coordinates](#coordinates)) - `Optional` **y**: undefined \| number ([more about coordinates](#coordinates)) - `Optional` **touchPosition**: "topLeft" | "top" | "topRight" | "left" | "center" | "right" | "bottomLeft" | "bottom" | "bottomRight" diff --git a/src/commands/realSwipe.ts b/src/commands/realSwipe.ts index 1095940..59ada34 100644 --- a/src/commands/realSwipe.ts +++ b/src/commands/realSwipe.ts @@ -25,14 +25,14 @@ export interface RealSwipeOptions { */ y?: number; /** Length of swipe (in pixels) - * @default 50 + * @default 10 * @example * cy.get(".drawer").realSwipe("toLeft", { length: 50 }) */ length?: number; /** - * Swipe step (how often new touch move will be generated). Less more precise - * ! Must be less than options.length + * Swipe step (how often new touch move will be generated). + * Must be less than or equal options.length * @default 10 * cy.get(".drawer").realSwipe("toLeft", { step: 5 }) */