forked from DefinitelyTyped/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdoh.d.ts
1980 lines (1970 loc) · 101 KB
/
doh.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Type definitions for Dojo v1.9
// Project: http://dojotoolkit.org
// Definitions by: Michael Van Sickle <https://github.com/vansimke>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace doh {
namespace plugins {
namespace alwaysAudio {
}
namespace hello {
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/plugins/remoteRobot.html
*
* Plugin that bridges the doh.robot and WebDriver APIs.
*
*/
interface remoteRobot {
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/plugins/android-webdriver-robot.html
*
*
*/
interface android_webdriver_robot {
/**
*
* @param sec
* @param charCode
* @param keyCode
* @param delay
*/
downKey(sec: any, charCode: any, keyCode: any, delay: any): void;
/**
*
* @param sec
* @param x
* @param y
* @param delay
* @param duration
*/
moveMouse(sec: any, x: any, y: any, delay: any, duration: any): void;
/**
*
* @param sec
* @param left
* @param middle
* @param right
* @param delay
*/
pressMouse(sec: any, left: any, middle: any, right: any, delay: any): void;
/**
*
* @param sec
* @param left
* @param middle
* @param right
* @param delay
*/
releaseMouse(sec: any, left: any, middle: any, right: any, delay: any): void;
/**
*
* @param sec
* @param docScreenX
* @param docScreenY
* @param width
* @param height
*/
setDocumentBounds(sec: any, docScreenX: any, docScreenY: any, width: any, height: any): void;
/**
*
* @param sec
* @param charCode
* @param keyCode
* @param alt
* @param ctrl
* @param shift
* @param meta
* @param delay
* @param async
*/
typeKey(sec: any, charCode: any, keyCode: any, alt: any, ctrl: any, shift: any, meta: any, delay: any, async: any): void;
/**
*
* @param chars
* @param delay
* @param duration
*/
typeKeys(chars: String, delay: number, duration: number): void;
/**
*
* @param chars
* @param delay
* @param duration
*/
typeKeys(chars: number, delay: number, duration: number): void;
/**
*
* @param sec
* @param charCode
* @param keyCode
* @param delay
*/
upKey(sec: any, charCode: any, keyCode: any, delay: any): void;
}
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/_nodeRunner.html
*
* Module for running DOH tests in node (as opposed to a browser).
* Augments return value from doh/runner.
*
*/
interface _nodeRunner {
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/_rhinoRunner.html
*
* Module for running DOH tests in rhino (as opposed to a browser).
* Augments return value from doh/runner.
*
*/
interface _rhinoRunner {
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/_parseURLargs.html
*
*
*/
interface _parseURLargs {
/**
*
*/
isDebug: boolean;
/**
*
*/
noGlobals: boolean;
/**
*
*/
scopeMap: any[];
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/_browserRunner.html
*
* Functions for registering and running automated tests.
*
*/
interface _browserRunner {
/**
*
*/
debug: Object;
/**
*
*/
error: Object;
/**
*
*/
isBrowser: boolean;
/**
*
*/
registerUrl: Object;
/**
*
*/
robot: Object;
/**
* are the passed expected and actual objects/values deeply
* equivalent?
*
* @param expected
* @param actual
* @param hint Optional
* @param doNotThrow
*/
assertEqual(expected: Object, actual: Object, hint: String, doNotThrow: any): void;
/**
* Test for a certain error to be thrown by the given function.
*
* @param expectedError
* @param scope
* @param functionName
* @param args
* @param hint Optional
*/
assertError(expectedError: Object, scope: Object, functionName: String, args: any[], hint: String): void;
/**
* is the passed item "falsey"?
*
* @param condition
* @param hint Optional
*/
assertFalse(condition: Object, hint: String): void;
/**
* are the passed notexpected and actual objects/values deeply
* not equivalent?
*
* @param notExpected
* @param actual
* @param hint Optional
*/
assertNotEqual(notExpected: Object, actual: Object, hint: String): void;
/**
* is the passed item "truthy"?
*
* @param condition
* @param hint Optional
*/
assertTrue(condition: Object, hint: String): void;
/**
*
* @param canceller
*/
Deferred(canceller: any): void;
/**
* Test for a certain error to be thrown by the given function.
*
* @param expectedError
* @param scope
* @param functionName
* @param args
* @param hint Optional
*/
e(expectedError: Object, scope: Object, functionName: String, args: any[], hint: String): void;
/**
* is the passed item "falsey"?
*
* @param condition
* @param hint Optional
*/
f(condition: Object, hint: String): void;
/**
* are the passed expected and actual objects/values deeply
* equivalent?
*
* @param expected
* @param actual
* @param hint Optional
* @param doNotThrow
*/
is(expected: Object, actual: Object, hint: String, doNotThrow: any): void;
/**
* are the passed notexpected and actual objects/values deeply
* not equivalent?
*
* @param notExpected
* @param actual
* @param hint Optional
*/
isNot(notExpected: Object, actual: Object, hint: String): void;
/**
* halt test run. Can be resumed.
*
*/
pause(): void;
/**
*
* @param a1
* @param a2
* @param a3
* @param a4
* @param a5
*/
register(a1: any, a2: any, a3: any, a4: any, a5: any): void;
/**
* Deprecated. Won't work unless you manually load dojox.testing.DocTest, and likely not even then.
* Gets all the doctests from the given module and register each of them as a single test case here.
*
* @param module dojox/dgauges/components/utils
*/
registerDocTests(module: any): void;
/**
* Deprecated. Use doh.register(group/type, tests, setUp, tearDown) instead
*
* @param group
* @param tests
* @param setUp
* @param tearDown
* @param type
*/
registerGroup(group: String, tests: any[], setUp: Function, tearDown: Function, type: String): void;
/**
* Deprecated. Use doh.register(group/type, tests, setUp, tearDown) instead
*
* @param group
* @param tests
* @param setUp
* @param tearDown
* @param type
*/
registerGroup(group: String, tests: Function, setUp: Function, tearDown: Function, type: String): void;
/**
* Deprecated. Use doh.register(group/type, tests, setUp, tearDown) instead
*
* @param group
* @param tests
* @param setUp
* @param tearDown
* @param type
*/
registerGroup(group: String, tests: Object, setUp: Function, tearDown: Function, type: String): void;
/**
* Deprecated. Use doh.register(group/type, test) instead
*
* @param group
* @param test
* @param type
*/
registerTest(group: String, test: any[], type: String): void;
/**
* Deprecated. Use doh.register(group/type, test) instead
*
* @param group
* @param test
* @param type
*/
registerTest(group: String, test: Function, type: String): void;
/**
* Deprecated. Use doh.register(group/type, test) instead
*
* @param group
* @param test
* @param type
*/
registerTest(group: String, test: Object, type: String): void;
/**
* Deprecated. Use doh.register(group, ns) instead
*
* @param group
* @param ns
*/
registerTestNs(group: String, ns: Object): void;
/**
* Deprecated. Use doh.register(group/type, testArr) instead
*
* @param group
* @param testArr
* @param type
*/
registerTests(group: String, testArr: any[], type: String): void;
/**
* Adds a test type and associates a function used to initialize each test of the given type
*
* @param name The name of the type.
* @param initProc Type specific test initializer; called after the test object is created.
*/
registerTestType(name: String, initProc: Function): void;
/**
*
*/
run(): void;
/**
* runs the specified test group
*
* @param groupName
* @param idx
*/
runGroup(groupName: String, idx: number): void;
/**
*
*/
runOnLoad(): void;
/**
*
*/
showLogPage(): void;
/**
*
*/
showPerfTestsPage(): void;
/**
*
*/
showTestPage(): void;
/**
* is the passed item "truthy"?
*
* @param condition
* @param hint Optional
*/
t(condition: Object, hint: String): void;
/**
*
*/
togglePaused(): void;
/**
*
*/
toggleRunAll(): void;
}
module _browserRunner {
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/_browserRunner._groups.html
*
*
*/
interface _groups {
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/_browserRunner._testTypes.html
*
*
*/
interface _testTypes {
/**
*
* @param group
* @param tObj
* @param type
*/
perf(group: any, tObj: any, type: any): void;
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/_browserRunner.robot.html
*
*
*/
interface robot {
/**
*
*/
doc: Object;
/**
*
*/
mouseWheelSize: number;
/**
*
*/
window: Object;
/**
* Opens the application at the specified URL for testing, redirecting dojo to point to the application
* environment instead of the test environment.
*
* @param url URL to open. Any of the test's dojo.doc calls (e.g. dojo.byId()), and any dijit.registry calls(e.g. dijit.byId()) will point to elements and widgets inside this application.
*/
initRobot(url: String): void;
/**
* Holds down a single key, like SHIFT or 'a'.
* Holds down a single key, like SHIFT or 'a'.
*
* @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to hold downWarning: holding down a shifted key, like 'A', can have unpredictable results.
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
*/
keyDown(charOrCode: number, delay: number): void;
/**
* Types a key combination, like SHIFT-TAB.
* Types a key combination, like SHIFT-TAB.
*
* @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to press
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param modifiers JSON object that represents all of the modifier keys being pressed.It takes the following Boolean attributes:shiftaltctrlmeta
* @param asynchronous If true, the delay happens asynchronously and immediately, outside of the browser's JavaScript thread and any previous calls.This is useful for interacting with the browser's modal dialogs.
*/
keyPress(charOrCode: number, delay: number, modifiers: Object, asynchronous: boolean): void;
/**
* Releases a single key, like SHIFT or 'a'.
* Releases a single key, like SHIFT or 'a'.
*
* @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to releaseWarning: releasing a shifted key, like 'A', can have unpredictable results.
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
*/
keyUp(charOrCode: number, delay: number): void;
/**
*
*/
killRobot(): void;
/**
* Convenience function to do a press/release.
* See robot.mousePress for more info.
* Convenience function to do a press/release.
* See robot.mousePress for more info.
*
* @param buttons
* @param delay Optional
*/
mouseClick(buttons: Object, delay: number): void;
/**
* Moves the mouse to the specified x,y offset relative to the viewport.
*
* @param x x offset relative to the viewport, in pixels, to move the mouse.
* @param y y offset relative to the viewport, in pixels, to move the mouse.
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration OptionalApproximate time Robot will spend moving the mouseThe default is 100ms. This also affects how many mousemove events willbe generated, which is the log of the duration.
* @param absolute Boolean indicating whether the x and y values are absolute coordinates.If false, then mouseMove expects that the x,y will be relative to the window. (clientX/Y)If true, then mouseMove expects that the x,y will be absolute. (pageX/Y)
*/
mouseMove(x: number, y: number, delay: number, duration: number, absolute: boolean): void;
/**
* Moves the mouse over the specified node at the specified relative x,y offset.
* Moves the mouse over the specified node at the specified relative x,y offset.
* If you do not specify an offset, mouseMove will default to move to the middle of the node.
* Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
*
* @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
* @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
* @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
* @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
*/
mouseMoveAt(node: String, delay: number, duration: number, offsetX: number, offsetY: number): void;
/**
* Moves the mouse over the specified node at the specified relative x,y offset.
* Moves the mouse over the specified node at the specified relative x,y offset.
* If you do not specify an offset, mouseMove will default to move to the middle of the node.
* Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
*
* @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
* @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
* @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
* @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
*/
mouseMoveAt(node: HTMLElement, delay: number, duration: number, offsetX: number, offsetY: number): void;
/**
* Moves the mouse over the specified node at the specified relative x,y offset.
* Moves the mouse over the specified node at the specified relative x,y offset.
* If you do not specify an offset, mouseMove will default to move to the middle of the node.
* Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
*
* @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
* @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
* @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
* @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
*/
mouseMoveAt(node: Function, delay: number, duration: number, offsetX: number, offsetY: number): void;
/**
* Move the mouse from the current position to the specified point.
* Delays reading contents point until queued command starts running.
* See mouseMove() for details.
*
* @param point x, y position relative to viewport, or if absolute == true, to document
* @param delay Optional
* @param duration Optional
* @param absolute
*/
mouseMoveTo(point: Object, delay: number, duration: number, absolute: boolean): void;
/**
* Presses mouse buttons.
* Presses the mouse buttons you pass as true.
* Example: to press the left mouse button, pass {left: true}.
* Mouse buttons you don't specify keep their previous pressed state.
*
* @param buttons JSON object that represents all of the mouse buttons being pressed.It takes the following Boolean attributes:leftmiddleright
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
*/
mousePress(buttons: Object, delay: number): void;
/**
* Releases mouse buttons.
* Releases the mouse buttons you pass as true.
* Example: to release the left mouse button, pass {left: true}.
* Mouse buttons you don't specify keep their previous pressed state.
* See robot.mousePress for more info.
*
* @param buttons
* @param delay Optional
*/
mouseRelease(buttons: Object, delay: number): void;
/**
* Spins the mouse wheel.
* Spins the wheel wheelAmt "notches."
* Negative wheelAmt scrolls up/away from the user.
* Positive wheelAmt scrolls down/toward the user.
* Note: this will all happen in one event.
* Warning: the size of one mouse wheel notch is an OS setting.
* You can access this size from robot.mouseWheelSize
*
* @param wheelAmt Number of notches to spin the wheel.Negative wheelAmt scrolls up/away from the user.Positive wheelAmt scrolls down/toward the user.
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms: robot.mouseClick({left: true}, 100) // first call; wait 100ms robot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration OptionalApproximate time Robot will spend moving the mouseBy default, the Robot will wheel the mouse as fast as possible.
*/
mouseWheel(wheelAmt: number, delay: number, duration: number): void;
/**
* Scroll the passed node into view, if it is not.
*
* @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
* @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
*/
scrollIntoView(node: String, delay: number): void;
/**
* Scroll the passed node into view, if it is not.
*
* @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
* @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
*/
scrollIntoView(node: HTMLElement, delay: number): void;
/**
* Scroll the passed node into view, if it is not.
*
* @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
* @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
*/
scrollIntoView(node: Function, delay: number): void;
/**
* Defer an action by adding it to the robot's incrementally delayed queue of actions to execute.
*
* @param f A function containing actions you want to defer. It can return a Promiseto delay further actions.
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration OptionalDelay to wait after firing.
*/
sequence(f: Function, delay: number, duration: number): void;
/**
* Set clipboard content.
* Set data as clipboard content, overriding anything already there. The
* data will be put to the clipboard using the given format.
*
* @param data New clipboard content to set
* @param format OptionalSet this to "text/html" to put richtext to the clipboard.Otherwise, data is treated as plaintext. By default, plaintextis used.
*/
setClipboard(data: String, format: String): void;
/**
*
*/
startRobot(): any;
/**
* Types a string of characters in order, or types a dojo.keys.* constant.
* Types a string of characters in order, or types a dojo.keys.* constant.
*
* @param chars String of characters to type, or a dojo.keys.* constant
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration OptionalTime, in milliseconds, to spend pressing all of the keys.The default is (string length)*50 ms.
*/
typeKeys(chars: String, delay: number, duration: number): void;
/**
* Types a string of characters in order, or types a dojo.keys.* constant.
* Types a string of characters in order, or types a dojo.keys.* constant.
*
* @param chars String of characters to type, or a dojo.keys.* constant
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration OptionalTime, in milliseconds, to spend pressing all of the keys.The default is (string length)*50 ms.
*/
typeKeys(chars: number, delay: number, duration: number): void;
/**
* Notifies DOH that the doh.robot is about to make a page change in the application it is driving,
* returning a doh.Deferred object the user should return in their runTest function as part of a DOH test.
*
* @param submitActions The doh.robot will execute the actions the test passes into the submitActions argument (like clicking the submit button),expecting these actions to create a page change (like a form submit).After these actions execute and the resulting page loads, the next test will start.
*/
waitForPageToLoad(submitActions: Function): any;
}
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/main.html
*
* Functions for registering and running automated tests.
*
*/
interface main {
/**
*
*/
debug: Object;
/**
*
*/
error: Object;
/**
*
*/
isBrowser: boolean;
/**
*
*/
registerUrl: Object;
/**
*
*/
robot: Object;
/**
* are the passed expected and actual objects/values deeply
* equivalent?
*
* @param expected
* @param actual
* @param hint Optional
* @param doNotThrow
*/
assertEqual(expected: Object, actual: Object, hint: String, doNotThrow: any): void;
/**
* Test for a certain error to be thrown by the given function.
*
* @param expectedError
* @param scope
* @param functionName
* @param args
* @param hint Optional
*/
assertError(expectedError: Object, scope: Object, functionName: String, args: any[], hint: String): void;
/**
* is the passed item "falsey"?
*
* @param condition
* @param hint Optional
*/
assertFalse(condition: Object, hint: String): void;
/**
* are the passed notexpected and actual objects/values deeply
* not equivalent?
*
* @param notExpected
* @param actual
* @param hint Optional
*/
assertNotEqual(notExpected: Object, actual: Object, hint: String): void;
/**
* is the passed item "truthy"?
*
* @param condition
* @param hint Optional
*/
assertTrue(condition: Object, hint: String): void;
/**
*
* @param canceller
*/
Deferred(canceller: any): void;
/**
* Test for a certain error to be thrown by the given function.
*
* @param expectedError
* @param scope
* @param functionName
* @param args
* @param hint Optional
*/
e(expectedError: Object, scope: Object, functionName: String, args: any[], hint: String): void;
/**
* is the passed item "falsey"?
*
* @param condition
* @param hint Optional
*/
f(condition: Object, hint: String): void;
/**
* are the passed expected and actual objects/values deeply
* equivalent?
*
* @param expected
* @param actual
* @param hint Optional
* @param doNotThrow
*/
is(expected: Object, actual: Object, hint: String, doNotThrow: any): void;
/**
* are the passed notexpected and actual objects/values deeply
* not equivalent?
*
* @param notExpected
* @param actual
* @param hint Optional
*/
isNot(notExpected: Object, actual: Object, hint: String): void;
/**
* halt test run. Can be resumed.
*
*/
pause(): void;
/**
*
* @param a1
* @param a2
* @param a3
* @param a4
* @param a5
*/
register(a1: any, a2: any, a3: any, a4: any, a5: any): void;
/**
* Deprecated. Won't work unless you manually load dojox.testing.DocTest, and likely not even then.
* Gets all the doctests from the given module and register each of them as a single test case here.
*
* @param module dojox/dgauges/components/utils
*/
registerDocTests(module: any): void;
/**
* Deprecated. Use doh.register(group/type, tests, setUp, tearDown) instead
*
* @param group
* @param tests
* @param setUp
* @param tearDown
* @param type
*/
registerGroup(group: String, tests: any[], setUp: Function, tearDown: Function, type: String): void;
/**
* Deprecated. Use doh.register(group/type, tests, setUp, tearDown) instead
*
* @param group
* @param tests
* @param setUp
* @param tearDown
* @param type
*/
registerGroup(group: String, tests: Function, setUp: Function, tearDown: Function, type: String): void;
/**
* Deprecated. Use doh.register(group/type, tests, setUp, tearDown) instead
*
* @param group
* @param tests
* @param setUp
* @param tearDown
* @param type
*/
registerGroup(group: String, tests: Object, setUp: Function, tearDown: Function, type: String): void;
/**
* Deprecated. Use doh.register(group/type, test) instead
*
* @param group
* @param test
* @param type
*/
registerTest(group: String, test: any[], type: String): void;
/**
* Deprecated. Use doh.register(group/type, test) instead
*
* @param group
* @param test
* @param type
*/
registerTest(group: String, test: Function, type: String): void;
/**
* Deprecated. Use doh.register(group/type, test) instead
*
* @param group
* @param test
* @param type
*/
registerTest(group: String, test: Object, type: String): void;
/**
* Deprecated. Use doh.register(group, ns) instead
*
* @param group
* @param ns
*/
registerTestNs(group: String, ns: Object): void;
/**
* Deprecated. Use doh.register(group/type, testArr) instead
*
* @param group
* @param testArr
* @param type
*/
registerTests(group: String, testArr: any[], type: String): void;
/**
* Adds a test type and associates a function used to initialize each test of the given type
*
* @param name The name of the type.
* @param initProc Type specific test initializer; called after the test object is created.
*/
registerTestType(name: String, initProc: Function): void;
/**
*
*/
run(): void;
/**
* runs the specified test group
*
* @param groupName
* @param idx
*/
runGroup(groupName: String, idx: number): void;
/**
*
*/
runOnLoad(): void;
/**
*
*/
showLogPage(): void;
/**
*
*/
showPerfTestsPage(): void;
/**
*
*/
showTestPage(): void;
/**
* is the passed item "truthy"?
*
* @param condition
* @param hint Optional
*/
t(condition: Object, hint: String): void;
/**
*
*/
togglePaused(): void;
/**
*
*/
toggleRunAll(): void;
}
namespace main {
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/main._groups.html
*
*
*/
interface _groups {
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/main._testTypes.html
*
*
*/
interface _testTypes {
/**
*
* @param group
* @param tObj
* @param type
*/
perf(group: any, tObj: any, type: any): void;
}
/**
* Permalink: http://dojotoolkit.org/api/1.9/doh/main.robot.html
*
*
*/
interface robot {
/**
*
*/
doc: Object;
/**
*
*/
mouseWheelSize: number;
/**
*
*/
window: Object;
/**
* Opens the application at the specified URL for testing, redirecting dojo to point to the application
* environment instead of the test environment.
*
* @param url URL to open. Any of the test's dojo.doc calls (e.g. dojo.byId()), and any dijit.registry calls(e.g. dijit.byId()) will point to elements and widgets inside this application.
*/
initRobot(url: String): void;
/**
* Holds down a single key, like SHIFT or 'a'.
* Holds down a single key, like SHIFT or 'a'.
*
* @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to hold downWarning: holding down a shifted key, like 'A', can have unpredictable results.
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
*/
keyDown(charOrCode: number, delay: number): void;
/**
* Types a key combination, like SHIFT-TAB.
* Types a key combination, like SHIFT-TAB.
*
* @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to press
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param modifiers JSON object that represents all of the modifier keys being pressed.It takes the following Boolean attributes:shiftaltctrlmeta
* @param asynchronous If true, the delay happens asynchronously and immediately, outside of the browser's JavaScript thread and any previous calls.This is useful for interacting with the browser's modal dialogs.
*/
keyPress(charOrCode: number, delay: number, modifiers: Object, asynchronous: boolean): void;
/**
* Releases a single key, like SHIFT or 'a'.
* Releases a single key, like SHIFT or 'a'.
*
* @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to releaseWarning: releasing a shifted key, like 'A', can have unpredictable results.
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
*/
keyUp(charOrCode: number, delay: number): void;
/**
*
*/
killRobot(): void;
/**
* Convenience function to do a press/release.
* See robot.mousePress for more info.
* Convenience function to do a press/release.
* See robot.mousePress for more info.
*
* @param buttons
* @param delay Optional
*/
mouseClick(buttons: Object, delay: number): void;
/**
* Moves the mouse to the specified x,y offset relative to the viewport.
*
* @param x x offset relative to the viewport, in pixels, to move the mouse.
* @param y y offset relative to the viewport, in pixels, to move the mouse.
* @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
* @param duration OptionalApproximate time Robot will spend moving the mouseThe default is 100ms. This also affects how many mousemove events willbe generated, which is the log of the duration.
* @param absolute Boolean indicating whether the x and y values are absolute coordinates.If false, then mouseMove expects that the x,y will be relative to the window. (clientX/Y)If true, then mouseMove expects that the x,y will be absolute. (pageX/Y)
*/
mouseMove(x: number, y: number, delay: number, duration: number, absolute: boolean): void;
/**
* Moves the mouse over the specified node at the specified relative x,y offset.