Upgrading puppeteer 19 to 20
Unknown19.11.1 → 20.9.0
Fetching 20 releases from GitHub…0 / 20
UnknownUpgrade verdict
DepDelta is still reading the notes for this range, so breaking changes can't be ruled out yet.
In plain terms
- DepDelta is still reading the release notes in this range, so it can't rule out breaking changes yet.
- This page updates as the notes come in.
Must act Still reading release notes
DepDelta is still reading the release notes in this range. This updates as they come in.
Requires Node.js >=16.3.0 from 20.6.0 (none stated before).
Drops https-proxy-agent, progress, proxy-from-env.
Installs 104 packages in all (was 79).
API changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- removed:
class AbortError extends CustomError - removed:
class BrowserFetcher - removed:
const EVALUATION_SCRIPT_URL = 'pptr://__puppeteer_evaluation_script__' - removed:
constructor BrowserFetcher(options: BrowserFetcherOptions) - removed:
interface BrowserFetcherOptions - removed:
interface BrowserFetcherRevisionInfo - removed:
interface CDPSessionOnMessageObject - removed:
interface ExperimentsConfiguration - removed:
interface PressOptions - removed:
method BrowserFetcher.canDownload(revision: string): Promise<boolean> - removed:
method BrowserFetcher.download(revision: string, progressCallback?: (x: number, y: number) => void): Promise<BrowserFetcherRevisionInfo | undefined> - removed:
method BrowserFetcher.host(): string - removed:
method BrowserFetcher.localRevisions(): string[] - removed:
method BrowserFetcher.platform(): Platform - removed:
method BrowserFetcher.product(): Product - removed:
method BrowserFetcher.remove(revision: string): Promise<void> - removed:
method BrowserFetcher.revisionInfo(revision: string): BrowserFetcherRevisionInfo - removed:
method Page.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> - removed:
method PuppeteerNode.createBrowserFetcher(options?: Partial<BrowserFetcherOptions>): BrowserFetcher - removed:
property BrowserFetcherOptions.host?: string - removed:
property BrowserFetcherOptions.path: string - removed:
property BrowserFetcherOptions.platform?: Platform - removed:
property BrowserFetcherOptions.product?: 'chrome' | 'firefox' - removed:
property BrowserFetcherOptions.useMacOSARMBinary?: boolean - removed:
property BrowserFetcherRevisionInfo.executablePath: string - removed:
property BrowserFetcherRevisionInfo.folderPath: string - removed:
property BrowserFetcherRevisionInfo.local: boolean - removed:
property BrowserFetcherRevisionInfo.product: string - removed:
property BrowserFetcherRevisionInfo.revision: string - removed:
property BrowserFetcherRevisionInfo.url: string - removed:
property CDPSessionOnMessageObject.error: { message: string; data: any; code: number } - removed:
property CDPSessionOnMessageObject.id?: number - removed:
property CDPSessionOnMessageObject.method: string - removed:
property CDPSessionOnMessageObject.params: Record<string, unknown> - removed:
property CDPSessionOnMessageObject.result?: any - removed:
property Configuration.downloadHost?: string - removed:
property ExperimentsConfiguration.macArmChromiumEnabled?: boolean - removed:
property JSHandle[__JSHandleSymbol]?: T - removed:
property PressOptions.delay?: number - removed:
property PressOptions.text?: string - removed:
type Platform = 'linux' | 'mac' | 'mac_arm' | 'win32' | 'win64' - changed:
method CommonEventEmitter.addListener(event: EventType, handler: Handler): CommonEventEmitter → method CommonEventEmitter.addListener(event: EventType, handler: Handler): this - changed:
method CommonEventEmitter.off(event: EventType, handler: Handler): CommonEventEmitter → method CommonEventEmitter.off(event: EventType, handler: Handler): this - changed:
method CommonEventEmitter.on(event: EventType, handler: Handler): CommonEventEmitter → method CommonEventEmitter.on(event: EventType, handler: Handler): this - changed:
method CommonEventEmitter.once(event: EventType, handler: Handler): CommonEventEmitter → method CommonEventEmitter.once(event: EventType, handler: Handler): this - changed:
method CommonEventEmitter.removeAllListeners(event?: EventType): CommonEventEmitter → method CommonEventEmitter.removeAllListeners(event?: EventType): this - changed:
method CommonEventEmitter.removeListener(event: EventType, handler: Handler): CommonEventEmitter → method CommonEventEmitter.removeListener(event: EventType, handler: Handler): this - changed:
method ElementHandle.press(key: KeyInput, options?: PressOptions): Promise<void> → method ElementHandle.press(key: KeyInput, options?: Readonly<KeyPressOptions>): Promise<void> - changed:
method ElementHandle.type(text: string, options?: { delay: number }): Promise<void> → method ElementHandle.type(text: string, options?: Readonly<KeyboardTypeOptions>): Promise<void> - changed:
method EventEmitter.addListener(event: EventType, handler: Handler<any>): EventEmitter → method EventEmitter.addListener(event: EventType, handler: Handler<any>): this - changed:
method EventEmitter.off(event: EventType, handler: Handler<any>): EventEmitter → method EventEmitter.off(event: EventType, handler: Handler<any>): this - changed:
method EventEmitter.on(event: EventType, handler: Handler<any>): EventEmitter → method EventEmitter.on(event: EventType, handler: Handler<any>): this - changed:
method EventEmitter.once(event: EventType, handler: Handler<any>): EventEmitter → method EventEmitter.once(event: EventType, handler: Handler<any>): this - changed:
method EventEmitter.removeAllListeners(event?: EventType): EventEmitter → method EventEmitter.removeAllListeners(event?: EventType): this - changed:
method EventEmitter.removeListener(event: EventType, handler: Handler<any>): EventEmitter → method EventEmitter.removeListener(event: EventType, handler: Handler<any>): this - changed:
method Frame.type(selector: string, text: string, options?: { delay: number }): Promise<void> → method Frame.type(selector: string, text: string, options?: Readonly<KeyboardTypeOptions>): Promise<void> - changed:
method Keyboard.down(key: KeyInput, options?: { text?: string; commands?: string[] }): Promise<void> → method Keyboard.down(key: KeyInput, options?: Readonly<KeyDownOptions>): Promise<void> - changed:
method Keyboard.press(key: KeyInput, options?: { delay?: number; text?: string; commands?: string[] }): Promise<void> → method Keyboard.press(key: KeyInput, options?: Readonly<KeyPressOptions>): Promise<void> - changed:
method Keyboard.type(text: string, options?: { delay?: number }): Promise<void> → method Keyboard.type(text: string, options?: Readonly<KeyboardTypeOptions>): Promise<void> - changed:
method Mouse.down(options?: MouseOptions): Promise<void> → method Mouse.down(options?: Readonly<MouseOptions>): Promise<void> - changed:
method Mouse.move(x: number, y: number, options?: MouseMoveOptions): Promise<void> → method Mouse.move(x: number, y: number, options?: Readonly<MouseMoveOptions>): Promise<void> - changed:
method Mouse.up(options?: MouseOptions): Promise<void> → method Mouse.up(options?: Readonly<MouseOptions>): Promise<void> - changed:
method Mouse.wheel(options?: MouseWheelOptions): Promise<void> → method Mouse.wheel(options?: Readonly<MouseWheelOptions>): Promise<void> - changed:
method Page.evaluateOnNewDocument<Params extends unknown[], Func extends (...args: Params) => unknown = (...args: Params) => unknown>(pageFunction: Func | string, ...args: Params): Promise<void> → method Page.evaluateOnNewDocument<Params extends unknown[], Func extends (...args: Params) => unknown = (...args: Params) => unknown>(pageFunction: Func | string, ...args: Params): Promise<NewDocumentScriptEvaluation> - changed:
method Page.off<K extends keyof PageEventObject>(eventName: K, handler: (event: PageEventObject[K]) => void): EventEmitter → method Page.off<K extends keyof PageEventObject>(eventName: K, handler: (event: PageEventObject[K]) => void): this - changed:
method Page.on<K extends keyof PageEventObject>(eventName: K, handler: (event: PageEventObject[K]) => void): EventEmitter → method Page.on<K extends keyof PageEventObject>(eventName: K, handler: (event: PageEventObject[K]) => void): this - changed:
method Page.once<K extends keyof PageEventObject>(eventName: K, handler: (event: PageEventObject[K]) => void): EventEmitter → method Page.once<K extends keyof PageEventObject>(eventName: K, handler: (event: PageEventObject[K]) => void): this - changed:
method Page.type(selector: string, text: string, options?: { delay: number }): Promise<void> → method Page.type(selector: string, text: string, options?: Readonly<KeyboardTypeOptions>): Promise<void> - added:
abstract class Locator<T> extends EventEmitter - added:
abstract method Locator.click<ElementType extends Element>(this: Locator<ElementType>, options?: Readonly<LocatorClickOptions>): Promise<void> - added:
abstract method Locator.fill<ElementType extends Element>(this: Locator<ElementType>, value: string, options?: Readonly<ActionOptions>): Promise<void> - added:
abstract method Locator.hover<ElementType extends Element>(this: Locator<ElementType>, options?: Readonly<ActionOptions>): Promise<void> - added:
abstract method Locator.scroll<ElementType extends Element>(this: Locator<ElementType>, options?: Readonly<LocatorScrollOptions>): Promise<void> - added:
abstract method Locator.setEnsureElementIsInTheViewport(value: boolean): this - added:
abstract method Locator.setTimeout(timeout: number): this - added:
abstract method Locator.setVisibility(visibility: VisibilityOption): this - added:
abstract method Locator.setWaitForEnabled(value: boolean): this - added:
abstract method Locator.setWaitForStableBoundingBox(value: boolean): this - added:
enum LocatorEmittedEvents - added:
interface ActionOptions - added:
interface AutofillData - added:
interface KeyDownOptions - added:
interface KeyboardTypeOptions - added:
interface LocatorEventObject - added:
interface LocatorOptions - added:
interface LocatorScrollOptions extends ActionOptions - added:
interface NewDocumentScriptEvaluation - added:
member LocatorEmittedEvents.Action = 'action' - added:
method ElementHandle.autofill(data: AutofillData): Promise<void> - added:
method Frame.locator<Selector extends string>(selector: Selector): Locator<NodeFor<Selector>> - added:
method Locator.off<K extends keyof LocatorEventObject>(eventName: K, handler: (event: LocatorEventObject[K]) => void): this - added:
method Locator.on<K extends keyof LocatorEventObject>(eventName: K, handler: (event: LocatorEventObject[K]) => void): this - added:
method Locator.once<K extends keyof LocatorEventObject>(eventName: K, handler: (event: LocatorEventObject[K]) => void): this - added:
method Mouse.reset(): Promise<void> - added:
method Page.isServiceWorkerBypassed(): boolean - added:
method Page.locator<Selector extends string>(selector: Selector): Locator<NodeFor<Selector>> - added:
method Page.removeExposedFunction(name: string): Promise<void> - added:
method Page.removeScriptToEvaluateOnNewDocument(identifier: string): Promise<void> - added:
method Page.setBypassServiceWorker(bypass: boolean): Promise<void> - added:
method PuppeteerNode.trimCache(): Promise<void> - added:
property ActionOptions.signal?: AbortSignal - added:
property AutofillData.creditCard: { number: string; name: string; expiryMonth: string; expiryYear: string; cvc: string } - added:
property Configuration.downloadBaseUrl?: string - added:
property FrameWaitForFunctionOptions.signal?: AbortSignal - added:
property JSHandle._?: T - added:
property KeyDownOptions.commands?: string[] - added:
property KeyDownOptions.text?: string - added:
property KeyboardTypeOptions.delay?: number - added:
property Locator._?: T - added:
property LocatorEventObject[LocatorEmittedEvents.Action]: never - added:
property LocatorOptions.ensureElementIsInTheViewport: boolean - added:
property LocatorOptions.timeout: number - added:
property LocatorOptions.visibility: VisibilityOption - added:
property LocatorOptions.waitForEnabled: boolean - added:
property LocatorOptions.waitForStableBoundingBox: boolean - added:
property LocatorScrollOptions.scrollLeft?: number - added:
property LocatorScrollOptions.scrollTop?: number - added:
property NewDocumentScriptEvaluation.identifier: string - added:
property ScreenshotOptions.optimizeForSpeed?: boolean - added:
static method Locator.race<Locators extends Array<Locator<unknown>>>(locators: Locators): Locator<UnionLocatorOf<Locators>> - added:
type ExperimentsConfiguration = Record<string, never> - added:
type KeyPressOptions = KeyDownOptions & KeyboardTypeOptions - added:
type LocatorClickOptions = ClickOptions & ActionOptions - added:
type Predicate<From, To extends From = From> = ((value: From) => value is To) | ((value: From) => Awaitable<boolean>) - added:
type VisibilityOption = 'hidden' | 'visible' | null