thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: added comments for browsercontext, startCSSCoverage, and startJSCoverage. (#7264)

Browse Source 
* fix: modified comment for method product, platform and newPage

* fix: added comment for browsercontext, StartCSSCoverage, StartJSCoverage
This commit is contained in:
TASNEEM KOUSHAR 2021-05-25 12:17:25 +05:30 committed by GitHub
parent 159d283545
commit b75039746a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/common/Coverage.ts
View File

@ -123,8 +123,8 @@ export class Coverage {
} }
/** /**
* @param options - defaults to * @param options - Set of configurable options for coverage defaults to `{
* `{ resetOnNavigation : true, reportAnonymousScripts : false }` * resetOnNavigation : true, reportAnonymousScripts : false }`
* @returns Promise that resolves when coverage is started. * @returns Promise that resolves when coverage is started.
* *
* @remarks * @remarks
@ -150,7 +150,8 @@ export class Coverage {
} }
/** /**
* @param options - defaults to `{ resetOnNavigation : true }` * @param options - Set of configurable options for coverage, defaults to `{
* resetOnNavigation : true }`
* @returns Promise that resolves when coverage is started. * @returns Promise that resolves when coverage is started.
*/ */
async startCSSCoverage(options: CSSCoverageOptions = {}): Promise<void> { async startCSSCoverage(options: CSSCoverageOptions = {}): Promise<void> {

8
src/common/EventEmitter.ts
View File

@ -55,7 +55,7 @@ export class EventEmitter implements CommonEventEmitter {
* Bind an event listener to fire when an event occurs. * Bind an event listener to fire when an event occurs.
* @param event - the event type you'd like to listen to. Can be a string or symbol. * @param event - the event type you'd like to listen to. Can be a string or symbol.
* @param handler - the function to be called when the event occurs. * @param handler - the function to be called when the event occurs.
* @returns `this` to enable you to chain calls. * @returns `this` to enable you to chain method calls.
*/ */
on(event: EventType, handler: Handler): EventEmitter { on(event: EventType, handler: Handler): EventEmitter {
this.emitter.on(event, handler); this.emitter.on(event, handler);
@ -66,7 +66,7 @@ export class EventEmitter implements CommonEventEmitter {
* Remove an event listener from firing. * Remove an event listener from firing.
* @param event - the event type you'd like to stop listening to. * @param event - the event type you'd like to stop listening to.
* @param handler - the function that should be removed. * @param handler - the function that should be removed.
* @returns `this` to enable you to chain calls. * @returns `this` to enable you to chain method calls.
*/ */
off(event: EventType, handler: Handler): EventEmitter { off(event: EventType, handler: Handler): EventEmitter {
this.emitter.off(event, handler); this.emitter.off(event, handler);
@ -107,7 +107,7 @@ export class EventEmitter implements CommonEventEmitter {
* Like `on` but the listener will only be fired once and then it will be removed. * Like `on` but the listener will only be fired once and then it will be removed.
* @param event - the event you'd like to listen to * @param event - the event you'd like to listen to
* @param handler - the handler function to run when the event occurs * @param handler - the handler function to run when the event occurs
* @returns `this` to enable you to chain calls. * @returns `this` to enable you to chain method calls.
*/ */
once(event: EventType, handler: Handler): EventEmitter { once(event: EventType, handler: Handler): EventEmitter {
const onceHandler: Handler = (eventData) => { const onceHandler: Handler = (eventData) => {
@ -132,7 +132,7 @@ export class EventEmitter implements CommonEventEmitter {
* Removes all listeners. If given an event argument, it will remove only * Removes all listeners. If given an event argument, it will remove only
* listeners for that event. * listeners for that event.
* @param event - the event to remove listeners for. * @param event - the event to remove listeners for.
* @returns `this` to enable you to chain calls. * @returns `this` to enable you to chain method calls.
*/ */
removeAllListeners(event?: EventType): EventEmitter { removeAllListeners(event?: EventType): EventEmitter {
if (event) { if (event) {

3
src/common/Target.ts
View File

@ -191,6 +191,9 @@ export class Target {
return this._browserContext.browser(); return this._browserContext.browser();
} }
/**
* Get the browser context the target belongs to.
*/
browserContext(): BrowserContext { browserContext(): BrowserContext {
return this._browserContext; return this._browserContext;
} }