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
|
/**
* Copyright 2017 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {Browser} from './Browser.js';
import {BrowserConnectOptions, _connectToBrowser} from './BrowserConnector.js';
import {ConnectionTransport} from './ConnectionTransport.js';
import {devices} from './DeviceDescriptors.js';
import {errors} from './Errors.js';
import {networkConditions} from './NetworkConditions.js';
import {
clearCustomQueryHandlers,
CustomQueryHandler,
customQueryHandlerNames,
registerCustomQueryHandler,
unregisterCustomQueryHandler,
} from './QueryHandler.js';
/**
* Settings that are common to the Puppeteer class, regardless of environment.
*
* @internal
*/
export interface CommonPuppeteerSettings {
isPuppeteerCore: boolean;
}
/**
* @public
*/
export interface ConnectOptions extends BrowserConnectOptions {
browserWSEndpoint?: string;
browserURL?: string;
transport?: ConnectionTransport;
}
/**
* The main Puppeteer class.
*
* IMPORTANT: if you are using Puppeteer in a Node environment, you will get an
* instance of {@link PuppeteerNode} when you import or require `puppeteer`.
* That class extends `Puppeteer`, so has all the methods documented below as
* well as all that are defined on {@link PuppeteerNode}.
* @public
*/
export class Puppeteer {
protected _isPuppeteerCore: boolean;
protected _changedProduct = false;
/**
* @internal
*/
constructor(settings: CommonPuppeteerSettings) {
this._isPuppeteerCore = settings.isPuppeteerCore;
this.connect = this.connect.bind(this);
}
/**
* This method attaches Puppeteer to an existing browser instance.
*
* @remarks
*
* @param options - Set of configurable options to set on the browser.
* @returns Promise which resolves to browser instance.
*/
connect(options: ConnectOptions): Promise<Browser> {
return _connectToBrowser(options);
}
/**
* @deprecated Import directly puppeteer.
* @example
*
* ```ts
* import {devices} from 'puppeteer';
* ```
*/
get devices(): typeof devices {
return devices;
}
/**
* @deprecated Import directly puppeteer.
* @example
*
* ```ts
* import {errors} from 'puppeteer';
* ```
*/
get errors(): typeof errors {
return errors;
}
/**
* @deprecated Import directly puppeteer.
* @example
*
* ```ts
* import {networkConditions} from 'puppeteer';
* ```
*/
get networkConditions(): typeof networkConditions {
return networkConditions;
}
/**
* @deprecated Import directly puppeteer.
* @example
*
* ```ts
* import {registerCustomQueryHandler} from 'puppeteer';
* ```
*/
registerCustomQueryHandler(
name: string,
queryHandler: CustomQueryHandler
): void {
return registerCustomQueryHandler(name, queryHandler);
}
/**
* @deprecated Import directly puppeteer.
* @example
*
* ```ts
* import {unregisterCustomQueryHandler} from 'puppeteer';
* ```
*/
unregisterCustomQueryHandler(name: string): void {
return unregisterCustomQueryHandler(name);
}
/**
* @deprecated Import directly puppeteer.
* @example
*
* ```ts
* import {customQueryHandlerNames} from 'puppeteer';
* ```
*/
customQueryHandlerNames(): string[] {
return customQueryHandlerNames();
}
/**
* @deprecated Import directly puppeteer.
* @example
*
* ```ts
* import {clearCustomQueryHandlers} from 'puppeteer';
* ```
*/
clearCustomQueryHandlers(): void {
return clearCustomQueryHandlers();
}
}
|
