Skip to content

Commit e51fc84

Browse files
authored
fix(types): pinch signature (wix#2758)
1 parent b708d30 commit e51fc84

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

detox/index.d.ts

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1028,8 +1028,19 @@ declare global {
10281028
* @example
10291029
* await expect(element(by.id('PinchableScrollView'))).toBeVisible();
10301030
* await element(by.id('PinchableScrollView')).pinchWithAngle('outward', 'slow', 0);
1031+
* @deprecated Should use pinch instead
10311032
*/
1032-
pinchWithAngle(direction: Direction, speed: Speed, angle: number): Promise<void>;
1033+
pinchWithAngle(direction: PinchDirection, speed: Speed, angle: number): Promise<void>;
1034+
1035+
/**
1036+
* Pinches with the given scale, speed, and angle. (iOS only)
1037+
* @param angle value in radiant, default is `0`
1038+
* @example
1039+
* await element(by.id('PinchableScrollView')).pinch(1.1);
1040+
* await element(by.id('PinchableScrollView')).pinch(2.0);
1041+
* await element(by.id('PinchableScrollView')).pinch(0.001);
1042+
*/
1043+
pinch(scale: number, speed: Speed, angle: number): Promise<void>;
10331044
}
10341045

10351046
interface WebExpect<R = Promise<void>> {
@@ -1138,6 +1149,8 @@ declare global {
11381149

11391150
type Direction = 'left' | 'right' | 'top' | 'bottom' | 'up' | 'down';
11401151

1152+
type PinchDirection = 'outward' | 'inward'
1153+
11411154
type Orientation = 'portrait' | 'landscape';
11421155

11431156
type Speed = 'fast' | 'slow';
@@ -1250,4 +1263,4 @@ declare global {
12501263
}
12511264

12521265
declare const detox: Detox.DetoxExportWrapper;
1253-
export = detox;
1266+
export = detox;

0 commit comments

Comments
 (0)