/** * Copyright 2022 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 { type EventType } from '../../third_party/mitt/mitt.js'; import { disposeSymbol } from '../util/disposable.js'; export type { /** * @public */ EventType, } from '../../third_party/mitt/mitt.js'; /** * @public */ export type Handler = (event: T) => void; /** * @public */ export interface CommonEventEmitter> { on(type: Key, handler: Handler): this; off(type: Key, handler?: Handler): this; emit(type: Key, event: Events[Key]): boolean; addListener(type: Key, handler: Handler): this; removeListener(type: Key, handler: Handler): this; once(type: Key, handler: Handler): this; listenerCount(event: keyof Events): number; removeAllListeners(event?: keyof Events): this; } /** * @public */ export type EventsWithWildcard> = Events & { '*': Events[keyof Events]; }; /** * The EventEmitter class that many Puppeteer classes extend. * * @remarks * * This allows you to listen to events that Puppeteer classes fire and act * accordingly. Therefore you'll mostly use {@link EventEmitter.on | on} and * {@link EventEmitter.off | off} to bind * and unbind to event listeners. * * @public */ export declare class EventEmitter> implements CommonEventEmitter> { #private; /** * @internal */ constructor(); /** * Bind an event listener to fire when an event occurs. * @param type - 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. * @returns `this` to enable you to chain method calls. */ on>(type: Key, handler: Handler[Key]>): this; /** * Remove an event listener from firing. * @param type - the event type you'd like to stop listening to. * @param handler - the function that should be removed. * @returns `this` to enable you to chain method calls. */ off>(type: Key, handler?: Handler[Key]>): this; /** * Remove an event listener. * * @deprecated please use {@link EventEmitter.off} instead. */ removeListener>(type: Key, handler: Handler[Key]>): this; /** * Add an event listener. * * @deprecated please use {@link EventEmitter.on} instead. */ addListener>(type: Key, handler: Handler[Key]>): this; /** * Emit an event and call any associated listeners. * * @param type - the event you'd like to emit * @param eventData - any data you'd like to emit with the event * @returns `true` if there are any listeners, `false` if there are not. */ emit>(type: Key, event: EventsWithWildcard[Key]): boolean; /** * Like `on` but the listener will only be fired once and then it will be removed. * @param type - the event you'd like to listen to * @param handler - the handler function to run when the event occurs * @returns `this` to enable you to chain method calls. */ once>(type: Key, handler: Handler[Key]>): this; /** * Gets the number of listeners for a given event. * * @param type - the event to get the listener count for * @returns the number of listeners bound to the given event */ listenerCount(type: keyof EventsWithWildcard): number; /** * Removes all listeners. If given an event argument, it will remove only * listeners for that event. * * @param type - the event to remove listeners for. * @returns `this` to enable you to chain method calls. */ removeAllListeners(type?: keyof EventsWithWildcard): this; } /** * @internal */ export declare class EventSubscription>, Type extends EventType = EventType, Event = unknown> { #private; constructor(target: Target, type: Type, handler: Handler); [disposeSymbol](): void; } //# sourceMappingURL=EventEmitter.d.ts.map