forked from microsoft/playwright-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.json
More file actions
17002 lines (17002 loc) · 671 KB
/
api.json
File metadata and controls
17002 lines (17002 loc) · 671 KB
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
{
"Browser": {
"name": "Browser",
"members": {
"disconnected": {
"kind": "event",
"name": "disconnected",
"type": null,
"comment": "",
"returnComment": "",
"required": true,
"templates": [],
"args": {}
},
"close": {
"kind": "method",
"name": "close",
"type": {
"name": "Promise",
"properties": {}
},
"comment": "In case this browser is obtained using browserType.launch, closes the browser and all of its pages (if any were opened).\nIn case this browser is obtained using browserType.connect, clears all created contexts belonging to this browser and disconnects from the browser server.\nThe Browser object itself is considered to be disposed and cannot be used anymore.",
"returnComment": "",
"required": true,
"templates": [],
"args": {}
},
"contexts": {
"kind": "method",
"name": "contexts",
"type": {
"name": "Array<BrowserContext>",
"properties": {}
},
"comment": "Returns an array of all open browser contexts. In a newly created browser, this will return zero\nbrowser contexts.\n```js\nconst browser = await pw.webkit.launch();\nconsole.log(browser.contexts().length); // prints `0`\n\nconst context = await browser.newContext();\nconsole.log(browser.contexts().length); // prints `1`\n```",
"returnComment": "",
"required": true,
"templates": [],
"args": {}
},
"isConnected": {
"kind": "method",
"name": "isConnected",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Indicates that the browser is connected.",
"returnComment": "",
"required": true,
"templates": [],
"args": {}
},
"newContext": {
"kind": "method",
"name": "newContext",
"type": {
"name": "Promise<BrowserContext>",
"properties": {}
},
"comment": "Creates a new browser context. It won't share cookies/cache with other browser contexts.\n```js\n(async () => {\n const browser = await playwright.firefox.launch(); // Or 'chromium' or 'webkit'.\n // Create a new incognito browser context.\n const context = await browser.newContext();\n // Create a new page in a pristine context.\n const page = await context.newPage();\n await page.goto('https://example.com');\n})();\n```",
"returnComment": "",
"required": true,
"templates": [],
"args": {
"options": {
"kind": "property",
"name": "options",
"type": {
"name": "Object",
"properties": {
"acceptDownloads": {
"kind": "property",
"name": "acceptDownloads",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.",
"returnComment": "",
"required": false,
"templates": []
},
"ignoreHTTPSErrors": {
"kind": "property",
"name": "ignoreHTTPSErrors",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether to ignore HTTPS errors during navigation. Defaults to `false`.",
"returnComment": "",
"required": false,
"templates": []
},
"bypassCSP": {
"kind": "property",
"name": "bypassCSP",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Toggles bypassing page's Content-Security-Policy.",
"returnComment": "",
"required": false,
"templates": []
},
"viewport": {
"kind": "property",
"name": "viewport",
"type": {
"name": "null|Object",
"properties": {
"width": {
"kind": "property",
"name": "width",
"type": {
"name": "number",
"properties": {}
},
"comment": "page width in pixels.",
"returnComment": "",
"required": true,
"templates": []
},
"height": {
"kind": "property",
"name": "height",
"type": {
"name": "number",
"properties": {}
},
"comment": "page height in pixels.",
"returnComment": "",
"required": true,
"templates": []
}
}
},
"comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport.",
"returnComment": "",
"required": false,
"templates": []
},
"userAgent": {
"kind": "property",
"name": "userAgent",
"type": {
"name": "string",
"properties": {}
},
"comment": "Specific user agent to use in this context.",
"returnComment": "",
"required": false,
"templates": []
},
"deviceScaleFactor": {
"kind": "property",
"name": "deviceScaleFactor",
"type": {
"name": "number",
"properties": {}
},
"comment": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.",
"returnComment": "",
"required": false,
"templates": []
},
"isMobile": {
"kind": "property",
"name": "isMobile",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported in Firefox.",
"returnComment": "",
"required": false,
"templates": []
},
"hasTouch": {
"kind": "property",
"name": "hasTouch",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Specifies if viewport supports touch events. Defaults to false.",
"returnComment": "",
"required": false,
"templates": []
},
"javaScriptEnabled": {
"kind": "property",
"name": "javaScriptEnabled",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether or not to enable JavaScript in the context. Defaults to true.",
"returnComment": "",
"required": false,
"templates": []
},
"timezoneId": {
"kind": "property",
"name": "timezoneId",
"type": {
"name": "string",
"properties": {}
},
"comment": "Changes the timezone of the context. See ICU’s `metaZones.txt` for a list of supported timezone IDs.",
"returnComment": "",
"required": false,
"templates": []
},
"geolocation": {
"kind": "property",
"name": "geolocation",
"type": {
"name": "Object",
"properties": {
"latitude": {
"kind": "property",
"name": "latitude",
"type": {
"name": "number",
"properties": {}
},
"comment": "Latitude between -90 and 90.",
"returnComment": "",
"required": true,
"templates": []
},
"longitude": {
"kind": "property",
"name": "longitude",
"type": {
"name": "number",
"properties": {}
},
"comment": "Longitude between -180 and 180.",
"returnComment": "",
"required": true,
"templates": []
},
"accuracy": {
"kind": "property",
"name": "accuracy",
"type": {
"name": "number",
"properties": {}
},
"comment": "Non-negative accuracy value. Defaults to `0`.",
"returnComment": "",
"required": false,
"templates": []
}
}
},
"comment": "",
"returnComment": "",
"required": false,
"templates": []
},
"locale": {
"kind": "property",
"name": "locale",
"type": {
"name": "string",
"properties": {}
},
"comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language` request header value as well as number and date formatting rules.",
"returnComment": "",
"required": false,
"templates": []
},
"permissions": {
"kind": "property",
"name": "permissions",
"type": {
"name": "Array<string>",
"properties": {}
},
"comment": "A list of permissions to grant to all pages in this context. See browserContext.grantPermissions for more details.",
"returnComment": "",
"required": false,
"templates": []
},
"extraHTTPHeaders": {
"kind": "property",
"name": "extraHTTPHeaders",
"type": {
"name": "Object<string, string>",
"properties": {}
},
"comment": "An object containing additional HTTP headers to be sent with every request. All header values must be strings.",
"returnComment": "",
"required": false,
"templates": []
},
"offline": {
"kind": "property",
"name": "offline",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether to emulate network being offline. Defaults to `false`.",
"returnComment": "",
"required": false,
"templates": []
},
"httpCredentials": {
"kind": "property",
"name": "httpCredentials",
"type": {
"name": "Object",
"properties": {
"username": {
"kind": "property",
"name": "username",
"type": {
"name": "string",
"properties": {}
},
"comment": "",
"returnComment": "",
"required": true,
"templates": []
},
"password": {
"kind": "property",
"name": "password",
"type": {
"name": "string",
"properties": {}
},
"comment": "",
"returnComment": "",
"required": true,
"templates": []
}
}
},
"comment": "Credentials for HTTP authentication.",
"returnComment": "",
"required": false,
"templates": []
},
"colorScheme": {
"kind": "property",
"name": "colorScheme",
"type": {
"name": "\"dark\"|\"light\"|\"no-preference\"",
"properties": {}
},
"comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See page.emulateMedia(options) for more details. Defaults to '`light`'.",
"returnComment": "",
"required": false,
"templates": []
},
"logger": {
"kind": "property",
"name": "logger",
"type": {
"name": "Logger",
"properties": {}
},
"comment": "Logger sink for Playwright logging.",
"returnComment": "",
"required": false,
"templates": []
},
"_recordVideos": {
"kind": "property",
"name": "_recordVideos",
"type": {
"name": "Object",
"properties": {
"width": {
"kind": "property",
"name": "width",
"type": {
"name": "number",
"properties": {}
},
"comment": "Video frame width.",
"returnComment": "",
"required": true,
"templates": []
},
"height": {
"kind": "property",
"name": "height",
"type": {
"name": "number",
"properties": {}
},
"comment": "Video frame height.",
"returnComment": "",
"required": true,
"templates": []
}
}
},
"comment": "**experimental** Enables automatic video recording for new pages. The video will have frames with the provided dimensions. Actual picture of the page will be scaled down if necessary to fit specified size.",
"returnComment": "",
"required": false,
"templates": []
}
}
},
"comment": "",
"returnComment": "",
"required": false,
"templates": []
}
}
},
"newPage": {
"kind": "method",
"name": "newPage",
"type": {
"name": "Promise<Page>",
"properties": {}
},
"comment": "Creates a new page in a new browser context. Closing this page will close the context as well.\nThis is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and testing frameworks should explicitly create browser.newContext followed by the browserContext.newPage to control their exact life times.",
"returnComment": "",
"required": true,
"templates": [],
"args": {
"options": {
"kind": "property",
"name": "options",
"type": {
"name": "Object",
"properties": {
"acceptDownloads": {
"kind": "property",
"name": "acceptDownloads",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.",
"returnComment": "",
"required": false,
"templates": []
},
"ignoreHTTPSErrors": {
"kind": "property",
"name": "ignoreHTTPSErrors",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether to ignore HTTPS errors during navigation. Defaults to `false`.",
"returnComment": "",
"required": false,
"templates": []
},
"bypassCSP": {
"kind": "property",
"name": "bypassCSP",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Toggles bypassing page's Content-Security-Policy.",
"returnComment": "",
"required": false,
"templates": []
},
"viewport": {
"kind": "property",
"name": "viewport",
"type": {
"name": "null|Object",
"properties": {
"width": {
"kind": "property",
"name": "width",
"type": {
"name": "number",
"properties": {}
},
"comment": "page width in pixels.",
"returnComment": "",
"required": true,
"templates": []
},
"height": {
"kind": "property",
"name": "height",
"type": {
"name": "number",
"properties": {}
},
"comment": "page height in pixels.",
"returnComment": "",
"required": true,
"templates": []
}
}
},
"comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport.",
"returnComment": "",
"required": false,
"templates": []
},
"userAgent": {
"kind": "property",
"name": "userAgent",
"type": {
"name": "string",
"properties": {}
},
"comment": "Specific user agent to use in this context.",
"returnComment": "",
"required": false,
"templates": []
},
"deviceScaleFactor": {
"kind": "property",
"name": "deviceScaleFactor",
"type": {
"name": "number",
"properties": {}
},
"comment": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.",
"returnComment": "",
"required": false,
"templates": []
},
"isMobile": {
"kind": "property",
"name": "isMobile",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported in Firefox.",
"returnComment": "",
"required": false,
"templates": []
},
"hasTouch": {
"kind": "property",
"name": "hasTouch",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Specifies if viewport supports touch events. Defaults to false.",
"returnComment": "",
"required": false,
"templates": []
},
"javaScriptEnabled": {
"kind": "property",
"name": "javaScriptEnabled",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether or not to enable JavaScript in the context. Defaults to `true`.",
"returnComment": "",
"required": false,
"templates": []
},
"timezoneId": {
"kind": "property",
"name": "timezoneId",
"type": {
"name": "string",
"properties": {}
},
"comment": "Changes the timezone of the context. See ICU’s `metaZones.txt` for a list of supported timezone IDs.",
"returnComment": "",
"required": false,
"templates": []
},
"geolocation": {
"kind": "property",
"name": "geolocation",
"type": {
"name": "Object",
"properties": {
"latitude": {
"kind": "property",
"name": "latitude",
"type": {
"name": "number",
"properties": {}
},
"comment": "Latitude between -90 and 90.",
"returnComment": "",
"required": true,
"templates": []
},
"longitude": {
"kind": "property",
"name": "longitude",
"type": {
"name": "number",
"properties": {}
},
"comment": "Longitude between -180 and 180.",
"returnComment": "",
"required": true,
"templates": []
},
"accuracy": {
"kind": "property",
"name": "accuracy",
"type": {
"name": "number",
"properties": {}
},
"comment": "Non-negative accuracy value. Defaults to `0`.",
"returnComment": "",
"required": false,
"templates": []
}
}
},
"comment": "",
"returnComment": "",
"required": false,
"templates": []
},
"locale": {
"kind": "property",
"name": "locale",
"type": {
"name": "string",
"properties": {}
},
"comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language` request header value as well as number and date formatting rules.",
"returnComment": "",
"required": false,
"templates": []
},
"permissions": {
"kind": "property",
"name": "permissions",
"type": {
"name": "Array<string>",
"properties": {}
},
"comment": "A list of permissions to grant to all pages in this context. See browserContext.grantPermissions for more details.",
"returnComment": "",
"required": false,
"templates": []
},
"extraHTTPHeaders": {
"kind": "property",
"name": "extraHTTPHeaders",
"type": {
"name": "Object<string, string>",
"properties": {}
},
"comment": "An object containing additional HTTP headers to be sent with every request. All header values must be strings.",
"returnComment": "",
"required": false,
"templates": []
},
"offline": {
"kind": "property",
"name": "offline",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "Whether to emulate network being offline. Defaults to `false`.",
"returnComment": "",
"required": false,
"templates": []
},
"httpCredentials": {
"kind": "property",
"name": "httpCredentials",
"type": {
"name": "Object",
"properties": {
"username": {
"kind": "property",
"name": "username",
"type": {
"name": "string",
"properties": {}
},
"comment": "",
"returnComment": "",
"required": true,
"templates": []
},
"password": {
"kind": "property",
"name": "password",
"type": {
"name": "string",
"properties": {}
},
"comment": "",
"returnComment": "",
"required": true,
"templates": []
}
}
},
"comment": "Credentials for HTTP authentication.",
"returnComment": "",
"required": false,
"templates": []
},
"colorScheme": {
"kind": "property",
"name": "colorScheme",
"type": {
"name": "\"dark\"|\"light\"|\"no-preference\"",
"properties": {}
},
"comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See page.emulateMedia(options) for more details. Defaults to '`light`'.",
"returnComment": "",
"required": false,
"templates": []
},
"logger": {
"kind": "property",
"name": "logger",
"type": {
"name": "Logger",
"properties": {}
},
"comment": "Logger sink for Playwright logging.",
"returnComment": "",
"required": false,
"templates": []
},
"_recordVideos": {
"kind": "property",
"name": "_recordVideos",
"type": {
"name": "Object",
"properties": {
"width": {
"kind": "property",
"name": "width",
"type": {
"name": "number",
"properties": {}
},
"comment": "Video frame width.",
"returnComment": "",
"required": true,
"templates": []
},
"height": {
"kind": "property",
"name": "height",
"type": {
"name": "number",
"properties": {}
},
"comment": "Video frame height.",
"returnComment": "",
"required": true,
"templates": []
}
}
},
"comment": "**experimental** Enables automatic video recording for the new page. The video will have frames with the provided dimensions. Actual picture of the page will be scaled down if necessary to fit specified size.",
"returnComment": "",
"required": false,
"templates": []
}
}
},
"comment": "",
"returnComment": "",
"required": false,
"templates": []
}
}
},
"version": {
"kind": "method",
"name": "version",
"type": {
"name": "string",
"properties": {}
},
"comment": "Returns the browser version.",
"returnComment": "",
"required": true,
"templates": [],
"args": {}
}
}
},
"BrowserContext": {
"name": "BrowserContext",
"members": {
"close": {
"kind": "method",
"name": "close",
"type": {
"name": "Promise",
"properties": {}
},
"comment": "Closes the browser context. All the pages that belong to the browser context\nwill be closed.\n\n**NOTE** the default browser context cannot be closed.",
"returnComment": "",
"required": true,
"templates": [],
"args": {}
},
"page": {
"kind": "event",
"name": "page",
"type": {
"name": "Page",
"properties": {}
},
"comment": "The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will also fire for popup pages. See also `Page.on('popup')` to receive events about popups relevant to a specific page.\nThe earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with `window.open('http://example.com')`, this event will fire when the network request to \"http://example.com\" is done and its response has started loading in the popup.\n```js\nconst [page] = await Promise.all([\n context.waitForEvent('page'),\n page.click('a[target=_blank]'),\n]);\nconsole.log(await page.evaluate('location.href'));\n```\n\n**NOTE** Use `page.waitForLoadState([state[, options]])` to wait until the page gets to a particular state (you should not need it in most cases).",
"returnComment": "",
"required": true,
"templates": [],
"args": {}
},
"addCookies": {
"kind": "method",
"name": "addCookies",
"type": {
"name": "Promise",
"properties": {}
},
"comment": "```js\nawait browserContext.addCookies([cookieObject1, cookieObject2]);\n```",
"returnComment": "",
"required": true,
"templates": [],
"args": {
"cookies": {
"kind": "property",
"name": "cookies",
"type": {
"name": "Array<Object>",
"properties": {
"name": {
"kind": "property",
"name": "name",
"type": {
"name": "string",
"properties": {}
},
"comment": "**required**",
"returnComment": "",
"required": true,
"templates": []
},
"value": {
"kind": "property",
"name": "value",
"type": {
"name": "string",
"properties": {}
},
"comment": "**required**",
"returnComment": "",
"required": true,
"templates": []
},
"url": {
"kind": "property",
"name": "url",
"type": {
"name": "string",
"properties": {}
},
"comment": "either url or domain / path are required",
"returnComment": "",
"required": false,
"templates": []
},
"domain": {
"kind": "property",
"name": "domain",
"type": {
"name": "string",
"properties": {}
},
"comment": "either url or domain / path are required",
"returnComment": "",
"required": false,
"templates": []
},
"path": {
"kind": "property",
"name": "path",
"type": {
"name": "string",
"properties": {}
},
"comment": "either url or domain / path are required",
"returnComment": "",
"required": false,
"templates": []
},
"expires": {
"kind": "property",
"name": "expires",
"type": {
"name": "number",
"properties": {}
},
"comment": "Unix time in seconds.",
"returnComment": "",
"required": false,
"templates": []
},
"httpOnly": {
"kind": "property",
"name": "httpOnly",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "",
"returnComment": "",
"required": false,
"templates": []
},
"secure": {
"kind": "property",
"name": "secure",
"type": {
"name": "boolean",
"properties": {}
},
"comment": "",
"returnComment": "",
"required": false,
"templates": []
},
"sameSite": {
"kind": "property",
"name": "sameSite",
"type": {
"name": "\"Lax\"|\"None\"|\"Strict\"",
"properties": {}
},
"comment": "",
"returnComment": "",
"required": false,
"templates": []
}
}
},
"comment": "",
"returnComment": "",
"required": true,
"templates": []
}
}
},
"addInitScript": {
"kind": "method",
"name": "addInitScript",
"type": {
"name": "Promise",
"properties": {}
},
"comment": "Adds a script which would be evaluated in one of the following scenarios:\n\nWhenever a page is created in the browser context or is navigated.\nWhenever a child frame is attached or navigated in any page in the browser context. In this case, the script is evaluated in the context of the newly attached frame.\n\nThe script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed `Math.random`.\nAn example of overriding `Math.random` before the page loads:\n```js\n// preload.js\nMath.random = () => 42;\n```\n```js\n// In your playwright script, assuming the preload.js file is in same folder.\nawait browserContext.addInitScript({\n path: 'preload.js'\n});\n```\n\n**NOTE** The order of evaluation of multiple scripts installed via browserContext.addInitScript(script[, arg]) and page.addInitScript(script[, arg]) is not defined.",
"returnComment": "",
"required": true,
"templates": [],
"args": {
"script": {
"kind": "property",
"name": "script",
"type": {
"name": "function|string|Object",
"properties": {
"path": {
"kind": "property",
"name": "path",
"type": {
"name": "string",
"properties": {}
},
"comment": "Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to current working directory.",
"returnComment": "",
"required": false,
"templates": []
},
"content": {
"kind": "property",
"name": "content",
"type": {