Upgrading puppeteer 16 to 17
Unknown16.2.0 → 17.1.3
Fetching 5 releases from GitHub…0 / 5
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.
API changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- added:
const InjectedUtil: { createDeferredPromise: typeof createDeferredPromise }
- changed:
constructor ElementHandle(context: ExecutionContext, client: CDPSession, remoteObject: Protocol.Runtime.RemoteObject, frame: Frame, page: Page, frameManager: FrameManager) → constructor ElementHandle(context: ExecutionContext, remoteObject: Protocol.Runtime.RemoteObject, frame: Frame) - changed:
method ElementHandle.waitForSelector<Selector extends string>(selector: Selector, options?: Exclude<WaitForSelectorOptions, 'root'>): Promise<ElementHandle<NodeFor<Selector>> | null> → method ElementHandle.waitForSelector<Selector extends string>(selector: Selector, options?: WaitForSelectorOptions): Promise<ElementHandle<NodeFor<Selector>> | null> - added:
get ElementHandle.frame(): Frame
- removed:
method ExecutionContext.frame(): Frame | null - removed:
method ExecutionContext.queryObjects<Prototype>(prototypeHandle: JSHandle<Prototype>): Promise<HandleFor<Prototype[]>>
- changed:
method Frame.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> → method Frame.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLLinkElement>> - added:
method Frame.addStyleTag(options: Omit<FrameAddStyleTagOptions, 'url'>): Promise<ElementHandle<HTMLStyleElement>> - added:
property FrameAddScriptTagOptions.id?: string
- removed:
method IsolatedWorld.addScriptTag(options: { url?: string; path?: string; content?: string; id?: string; type?: string }): Promise<ElementHandle<HTMLScriptElement>> - removed:
method IsolatedWorld.addStyleTag(options: { url?: string; path?: string; content?: string }): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> - removed:
method IsolatedWorld.waitForSelector<Selector extends string>(selector: Selector, options: WaitForSelectorOptions): Promise<ElementHandle<NodeFor<Selector>> | null> - removed:
property WaitForSelectorOptions.root?: ElementHandle<Node> - changed:
constructor IsolatedWorld(client: CDPSession, frameManager: FrameManager, frame: Frame, timeoutSettings: TimeoutSettings) → constructor IsolatedWorld(frame: Frame, injected?: boolean) - changed:
method IsolatedWorld._waitForSelectorInPage(queryOne: Function, selector: string, options: WaitForSelectorOptions, binding?: PageBinding): Promise<ElementHandle<Node> | null> → method IsolatedWorld._waitForSelectorInPage(queryOne: Function, root: ElementHandle<Node> | undefined, selector: string, options: WaitForSelectorOptions, binding?: PageBinding): Promise<JSHandle<unknown> | null> - added:
method IsolatedWorld.transferHandle<T extends JSHandle<Node>>(handle: T): Promise<T>
- changed:
constructor JSHandle(context: ExecutionContext, client: CDPSession, remoteObject: Protocol.Runtime.RemoteObject) → constructor JSHandle(context: ExecutionContext, remoteObject: Protocol.Runtime.RemoteObject)
- changed:
method Page.addScriptTag(options: { url?: string; path?: string; content?: string; type?: string; id?: string }): Promise<ElementHandle<HTMLScriptElement>> → method Page.addScriptTag(options: FrameAddScriptTagOptions): Promise<ElementHandle<HTMLScriptElement>> - changed:
method Page.addStyleTag(options: { url?: string; path?: string; content?: string }): Promise<ElementHandle<Node>> → method Page.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLLinkElement>> - changed:
method Page.waitForSelector<Selector extends string>(selector: Selector, options?: Exclude<WaitForSelectorOptions, 'root'>): Promise<ElementHandle<NodeFor<Selector>> | null> → method Page.waitForSelector<Selector extends string>(selector: Selector, options?: WaitForSelectorOptions): Promise<ElementHandle<NodeFor<Selector>> | null> - added:
method Page.addStyleTag(options: Omit<FrameAddStyleTagOptions, 'url'>): Promise<ElementHandle<HTMLStyleElement>> - added:
method Page.getDefaultTimeout(): number - added:
property ScreenshotClip.scale?: number
- removed:
property InternalQueryHandler.queryAllArray?: (element: ElementHandle<Node>, selector: string) => Promise<JSHandle<Node[]>> - changed:
property InternalQueryHandler.waitFor?: (isolatedWorld: IsolatedWorld, selector: string, options: WaitForSelectorOptions) => Promise<ElementHandle<Node> | null> → property InternalQueryHandler.waitFor?: (elementOrFrame: ElementHandle<Node> | Frame, selector: string, options: WaitForSelectorOptions) => Promise<ElementHandle<Node> | null>
- added:
const DEFERRED_PROMISE_DEBUG_TIMEOUT: number
- changed:
const source = '\"use strict\";\nvar __defProp = Object.defineProperty;\nvar __getOwnPropDesc = Object.getOwnPropertyDescriptor;\nvar __getOwnPropNames = Object.getOwnPropertyNames;\nvar __hasOwnProp = Object.prototype.hasOwnProperty;\nvar __export = (target, all) => {\n for (var name in all)\n __defProp(target, name, { get: all[name], enumerable: true });\n};\nvar __copyProps = (to, from, ex… → const source = '\"use strict\";\nvar __defProp = Object.defineProperty;\nvar __export = (target, all) => {\n for (var name in all)\n __defProp(target, name, { get: all[name], enumerable: true });\n};\nvar __accessCheck = (obj, member, msg) => {\n if (!member.has(obj))\n throw TypeError(\"Cannot \" + msg);\n};\nvar __privateGet = (obj, member, getter) => {\n __accessCheck(obj, member, \"r… - added:
declare global
- changed:
const packageVersion = '16.2.0' → const packageVersion = '17.1.3'
- removed:
export * from './Poller'
- added:
const createFunction: (functionValue: string) => (...args: unknown[]) => unknown
- changed:
static method NodeWebSocketTransport.create(urlString: string): Promise<NodeWebSocketTransport> → static method NodeWebSocketTransport.create(url: string): Promise<NodeWebSocketTransport>
- changed:
const PUPPETEER_REVISIONS: Readonly<{ chromium: '1022525'; firefox: 'latest' }> → const PUPPETEER_REVISIONS: Readonly<{ chromium: '1036745'; firefox: 'latest' }>
- added:
export * from './util/DebuggableDeferredPromise' - added:
export * from './util/DeferredPromise' - added:
export * from './util/ErrorLike' - added:
export * from './util/assert' - added:
export * from './util/getPackageDirectory'
- added:
function createDebuggableDeferredPromise<T>(message: string): DeferredPromise<T>
- removed:
function createDeferredPromiseWithTimer<T>(timeoutMessage: string, timeout?: number): DeferredPromise<T> - changed:
function createDeferredPromise<T>(): DeferredPromise<T> → function createDeferredPromise<T>(opts?: DeferredPromiseOptions): DeferredPromise<T> - added:
interface DeferredPromiseOptions - added:
property DeferredPromiseOptions.message: string - added:
property DeferredPromiseOptions.timeout: number
- changed:
constructor ElementHandle(context: ExecutionContext, client: CDPSession, remoteObject: Protocol.Runtime.RemoteObject, frame: Frame, page: Page, frameManager: FrameManager) → constructor ElementHandle(context: ExecutionContext, remoteObject: Protocol.Runtime.RemoteObject, frame: Frame) - changed:
method ElementHandle.waitForSelector<Selector extends string>(selector: Selector, options?: Exclude<WaitForSelectorOptions, 'root'>): Promise<ElementHandle<NodeFor<Selector>> | null> → method ElementHandle.waitForSelector<Selector extends string>(selector: Selector, options?: WaitForSelectorOptions): Promise<ElementHandle<NodeFor<Selector>> | null> - added:
get ElementHandle.frame(): Frame
- removed:
method ExecutionContext.frame(): Frame | null - removed:
method ExecutionContext.queryObjects<Prototype>(prototypeHandle: JSHandle<Prototype>): Promise<HandleFor<Prototype[]>>
- changed:
method Frame.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> → method Frame.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLLinkElement>> - added:
method Frame.addStyleTag(options: Omit<FrameAddStyleTagOptions, 'url'>): Promise<ElementHandle<HTMLStyleElement>> - added:
property FrameAddScriptTagOptions.id?: string
- removed:
method IsolatedWorld.addScriptTag(options: { url?: string; path?: string; content?: string; id?: string; type?: string }): Promise<ElementHandle<HTMLScriptElement>> - removed:
method IsolatedWorld.addStyleTag(options: { url?: string; path?: string; content?: string }): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> - removed:
method IsolatedWorld.waitForSelector<Selector extends string>(selector: Selector, options: WaitForSelectorOptions): Promise<ElementHandle<NodeFor<Selector>> | null> - removed:
property WaitForSelectorOptions.root?: ElementHandle<Node> - changed:
constructor IsolatedWorld(client: CDPSession, frameManager: FrameManager, frame: Frame, timeoutSettings: TimeoutSettings) → constructor IsolatedWorld(frame: Frame, injected?: boolean) - changed:
method IsolatedWorld._waitForSelectorInPage(queryOne: Function, selector: string, options: WaitForSelectorOptions, binding?: PageBinding): Promise<ElementHandle<Node> | null> → method IsolatedWorld._waitForSelectorInPage(queryOne: Function, root: ElementHandle<Node> | undefined, selector: string, options: WaitForSelectorOptions, binding?: PageBinding): Promise<JSHandle<unknown> | null> - added:
method IsolatedWorld.transferHandle<T extends JSHandle<Node>>(handle: T): Promise<T>
- changed:
constructor JSHandle(context: ExecutionContext, client: CDPSession, remoteObject: Protocol.Runtime.RemoteObject) → constructor JSHandle(context: ExecutionContext, remoteObject: Protocol.Runtime.RemoteObject)
- changed:
method Page.addScriptTag(options: { url?: string; path?: string; content?: string; type?: string; id?: string }): Promise<ElementHandle<HTMLScriptElement>> → method Page.addScriptTag(options: FrameAddScriptTagOptions): Promise<ElementHandle<HTMLScriptElement>> - changed:
method Page.addStyleTag(options: { url?: string; path?: string; content?: string }): Promise<ElementHandle<Node>> → method Page.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLLinkElement>> - changed:
method Page.waitForSelector<Selector extends string>(selector: Selector, options?: Exclude<WaitForSelectorOptions, 'root'>): Promise<ElementHandle<NodeFor<Selector>> | null> → method Page.waitForSelector<Selector extends string>(selector: Selector, options?: WaitForSelectorOptions): Promise<ElementHandle<NodeFor<Selector>> | null> - added:
method Page.addStyleTag(options: Omit<FrameAddStyleTagOptions, 'url'>): Promise<ElementHandle<HTMLStyleElement>> - added:
method Page.getDefaultTimeout(): number - added:
property ScreenshotClip.scale?: number
- removed:
property InternalQueryHandler.queryAllArray?: (element: ElementHandle<Node>, selector: string) => Promise<JSHandle<Node[]>> - changed:
property InternalQueryHandler.waitFor?: (isolatedWorld: IsolatedWorld, selector: string, options: WaitForSelectorOptions) => Promise<ElementHandle<Node> | null> → property InternalQueryHandler.waitFor?: (elementOrFrame: ElementHandle<Node> | Frame, selector: string, options: WaitForSelectorOptions) => Promise<ElementHandle<Node> | null>
- added:
const DEFERRED_PROMISE_DEBUG_TIMEOUT: number
- changed:
const source = '\"use strict\";\nvar __defProp = Object.defineProperty;\nvar __getOwnPropDesc = Object.getOwnPropertyDescriptor;\nvar __getOwnPropNames = Object.getOwnPropertyNames;\nvar __hasOwnProp = Object.prototype.hasOwnProperty;\nvar __export = (target, all) => {\n for (var name in all)\n __defProp(target, name, { get: all[name], enumerable: true });\n};\nvar __copyProps = (to, from, ex… → const source = '\"use strict\";\nvar __defProp = Object.defineProperty;\nvar __export = (target, all) => {\n for (var name in all)\n __defProp(target, name, { get: all[name], enumerable: true });\n};\nvar __accessCheck = (obj, member, msg) => {\n if (!member.has(obj))\n throw TypeError(\"Cannot \" + msg);\n};\nvar __privateGet = (obj, member, getter) => {\n __accessCheck(obj, member, \"r… - added:
declare global
- changed:
const packageVersion = '16.2.0' → const packageVersion = '17.1.3'
- removed:
export * from './Poller'
- added:
const createFunction: (functionValue: string) => (...args: unknown[]) => unknown
- changed:
static method NodeWebSocketTransport.create(urlString: string): Promise<NodeWebSocketTransport> → static method NodeWebSocketTransport.create(url: string): Promise<NodeWebSocketTransport>
- changed:
const PUPPETEER_REVISIONS: Readonly<{ chromium: '1022525'; firefox: 'latest' }> → const PUPPETEER_REVISIONS: Readonly<{ chromium: '1036745'; firefox: 'latest' }>
- added:
export * from './util/DebuggableDeferredPromise' - added:
export * from './util/DeferredPromise' - added:
export * from './util/ErrorLike' - added:
export * from './util/assert' - added:
export * from './util/getPackageDirectory'
- added:
function createDebuggableDeferredPromise<T>(message: string): DeferredPromise<T>
- removed:
function createDeferredPromiseWithTimer<T>(timeoutMessage: string, timeout?: number): DeferredPromise<T> - changed:
function createDeferredPromise<T>(): DeferredPromise<T> → function createDeferredPromise<T>(opts?: DeferredPromiseOptions): DeferredPromise<T> - added:
interface DeferredPromiseOptions - added:
property DeferredPromiseOptions.message: string - added:
property DeferredPromiseOptions.timeout: number
- removed:
class ExecutionContext - removed:
method ExecutionContext.evaluate<Params extends unknown[], Func extends EvaluateFunc<Params> = EvaluateFunc<Params>>(pageFunction: Func | string, ...args: Params): Promise<Awaited<ReturnType<Func>>> - removed:
method ExecutionContext.evaluateHandle<Params extends unknown[], Func extends EvaluateFunc<Params> = EvaluateFunc<Params>>(pageFunction: Func | string, ...args: Params): Promise<HandleFor<Awaited<ReturnType<Func>>>> - removed:
method ExecutionContext.frame(): Frame | null - removed:
method ExecutionContext.queryObjects<Prototype>(prototypeHandle: JSHandle<Prototype>): Promise<HandleFor<Prototype[]>> - removed:
method Frame.executionContext(): Promise<ExecutionContext> - removed:
method JSHandle.executionContext(): ExecutionContext - removed:
method WebWorker.executionContext(): Promise<ExecutionContext> - removed:
property WaitForSelectorOptions.root?: ElementHandle<Node> - changed:
method ElementHandle.waitForSelector<Selector extends string>(selector: Selector, options?: Exclude<WaitForSelectorOptions, 'root'>): Promise<ElementHandle<NodeFor<Selector>> | null> → method ElementHandle.waitForSelector<Selector extends string>(selector: Selector, options?: WaitForSelectorOptions): Promise<ElementHandle<NodeFor<Selector>> | null> - changed:
method Frame.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> → method Frame.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLLinkElement>> - changed:
method Page.addScriptTag(options: { url?: string; path?: string; content?: string; type?: string; id?: string }): Promise<ElementHandle<HTMLScriptElement>> → method Page.addScriptTag(options: FrameAddScriptTagOptions): Promise<ElementHandle<HTMLScriptElement>> - changed:
method Page.addStyleTag(options: { url?: string; path?: string; content?: string }): Promise<ElementHandle<Node>> → method Page.addStyleTag(options: FrameAddStyleTagOptions): Promise<ElementHandle<HTMLLinkElement>> - changed:
method Page.waitForSelector<Selector extends string>(selector: Selector, options?: Exclude<WaitForSelectorOptions, 'root'>): Promise<ElementHandle<NodeFor<Selector>> | null> → method Page.waitForSelector<Selector extends string>(selector: Selector, options?: WaitForSelectorOptions): Promise<ElementHandle<NodeFor<Selector>> | null> - added:
get ElementHandle.frame(): Frame - added:
method Frame.addStyleTag(options: Omit<FrameAddStyleTagOptions, 'url'>): Promise<ElementHandle<HTMLStyleElement>> - added:
method Page.addStyleTag(options: Omit<FrameAddStyleTagOptions, 'url'>): Promise<ElementHandle<HTMLStyleElement>> - added:
method Page.getDefaultTimeout(): number - added:
property FrameAddScriptTagOptions.id?: string - added:
property ScreenshotClip.scale?: number