62da2366c6
Introduce `//lib/api.js` that declares a list of publicly exposed classes. The `//lib/api.js` list superceedes dynamic `helper.tracePublicAPI()` calls and is used in the following places: - [ASYNC STACKS]: generate "async stacks" for publicy exposed API in `//index.js` - [COVERAGE]: move coverage support from `//lib/helper` to `//test/utils` - [DOCLINT]: get rid of 'exluded classes' hardcoded list This will help us to re-use our coverage and doclint infrastructure for Puppeteer-Firefox. Drive-By: it turns out we didn't run coverage for `SecurityDetails` class, so we lack coverage for a few methods there. These are excluded for now, sanity tests will be added in a follow-up.
70 lines
2.0 KiB
JavaScript
70 lines
2.0 KiB
JavaScript
/**
|
|
* 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.
|
|
*/
|
|
const Launcher = require('./Launcher');
|
|
const BrowserFetcher = require('./BrowserFetcher');
|
|
|
|
module.exports = class {
|
|
/**
|
|
* @param {string} projectRoot
|
|
* @param {string} preferredRevision
|
|
* @param {boolean} isPuppeteerCore
|
|
*/
|
|
constructor(projectRoot, preferredRevision, isPuppeteerCore) {
|
|
this._projectRoot = projectRoot;
|
|
this._launcher = new Launcher(projectRoot, preferredRevision, isPuppeteerCore);
|
|
}
|
|
|
|
/**
|
|
* @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions)=} options
|
|
* @return {!Promise<!Puppeteer.Browser>}
|
|
*/
|
|
launch(options) {
|
|
return this._launcher.launch(options);
|
|
}
|
|
|
|
/**
|
|
* @param {!(Launcher.BrowserOptions & {browserWSEndpoint?: string, browserURL?: string, transport?: !Puppeteer.ConnectionTransport})} options
|
|
* @return {!Promise<!Puppeteer.Browser>}
|
|
*/
|
|
connect(options) {
|
|
return this._launcher.connect(options);
|
|
}
|
|
|
|
/**
|
|
* @return {string}
|
|
*/
|
|
executablePath() {
|
|
return this._launcher.executablePath();
|
|
}
|
|
|
|
/**
|
|
* @param {!Launcher.ChromeArgOptions=} options
|
|
* @return {!Array<string>}
|
|
*/
|
|
defaultArgs(options) {
|
|
return this._launcher.defaultArgs(options);
|
|
}
|
|
|
|
/**
|
|
* @param {!BrowserFetcher.Options=} options
|
|
* @return {!BrowserFetcher}
|
|
*/
|
|
createBrowserFetcher(options) {
|
|
return new BrowserFetcher(this._projectRoot, options);
|
|
}
|
|
};
|
|
|