node-fetch を 2.x から 3.x へアップグレード

node-fetch 2.7.0 と 3.3.2 の公開 API を、TypeScript の型から自動的に比較したものです。シグネチャの変更は破壊的変更の候補であり、確定ではありません。

概要

削除されたインポートパス
`node-fetch/externals`

import	export	kind	変更前
`node-fetch`	`HeaderInit`	type	`Headers \| string[][] \| { [key: string]: string \| string[]; }`
`node-fetch`	`RequestMode`	type	`"same-origin" \| "cors" \| "no-cors"`
`node-fetch`	`RequestCache`	type	`"default" \| "force-cache" \| "no-cache" \| "no-store" \| "only-if-cached" \| "reload"`
`node-fetch`	`ResponseType`	type	`"error" \| "default" \| "cors" \| "basic" \| "opaque" \| "opaqueredirect"`
`node-fetch`	`RequestContext`	type	`"object" \| "audio" \| "beacon" \| "cspreport" \| "download" \| "embed" \| "eventsource" \| "favicon" \| "fetch" \| "font" \| "form" \| "frame" \| "hyperlink" \| "iframe" \| "image" \| "imageset" \| "import" \| "internal" \| "location" \| "manifest" \| "ping" \| "plugin" \| "prefetch" \| "script" \| "serviceworker" \| "sharedworker" \| "style" \| "subresource" \| "track" \| "video" \| "worker" \| "xmlhttprequest" \| "xslt"`
`node-fetch`	`RequestCredentials`	type	`"omit" \| "include" \| "same-origin"`

export	変更前	変更後
`node-fetch · Blob`	`class`	`any`
`node-fetch · Body`	`class`	`interface`
`node-fetch · default`	`(url: RequestInfo, init?: RequestInit \| undefined): Promise<Response>`	`(url: URL \| RequestInfo, init?: RequestInit \| undefined): Promise<Response>`
`node-fetch · HeadersInit`	`Headers \| string[][] \| { [key: string]: string \| string[]; }`	`Headers \| Record<string, string> \| Iterable<readonly [string, string]> \| Iterable<Iterable<string>>`
`node-fetch · RequestInfo`	`string \| Request \| URLLike`	`string \| Request`

member	変更前	変更後
`Body.body`	`NodeJS.ReadableStream`	`any`
`Body.json`	`(): Promise<any>`	`(): Promise<unknown>`
`Body.constructor`	`(body?: any, opts?: { size?: number \| undefined; timeout?: number \| undefined; } \| undefined): Body`
`Headers.raw`	`(): { [k: string]: string[]; }`	`(): Record<string, string[]>`
`Headers.forEach`	`(callback: (value: string, name: string) => void): void`	`(callbackfn: (value: string, key: string, parent: Headers) => void, thisArg?: any): void`
`Request.body`	`NodeJS.ReadableStream`	`any`
`Request.json`	`(): Promise<any>`	`(): Promise<unknown>`
`Request.constructor`	`(input: RequestInfo, init?: RequestInit \| undefined): Request`	`(input: URL \| RequestInfo, init?: RequestInit \| undefined): Request`
`Response.body`	`NodeJS.ReadableStream`	`any`
`Response.json`	`(): Promise<any>`	`(): Promise<unknown>`
`Response.static redirect`	`(url: string, status: number): Response`	`(url: string, status?: number \| undefined): Response`
`AbortError.type`	`"aborted"`	`string`
`AbortError.constructor`	`(message: string): AbortError`	`(message?: string \| undefined): AbortError \| (message?: string \| undefined, options?: ErrorOptions \| undefined): AbortError`
`FetchError.constructor`	`(message: string, type: string, systemError?: SystemError \| undefined): FetchError`	`(message: string, type: string, systemError?: Record<string, unknown> \| undefined): FetchError`

export	@deprecated
`node-fetch · Body.buffer`	Use `body.arrayBuffer()` instead.
`node-fetch · Request.buffer`	Use `body.arrayBuffer()` instead.
`node-fetch · Response.buffer`	Use `body.arrayBuffer()` instead.

	変更前	変更後
`engines.node`	`4.x \|\| >=6.0.0`	`^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0`
`peerDependencies.encoding`	`^0.1.0`	`—`

新しいエクスポート (7)

node-fetch を 2 から 3 にアップグレードする際の破壊的変更は？

node-fetch 2.7.0 と 3.3.2 の間で、Vigia は削除されたエクスポートを 6 件、変更されたシグネチャを 5 件、削除または変更されたクラス／インターフェースのメンバーを 33 件検出しました。

node-fetch 3 で非推奨になったものは？

node-fetch 3.3.2 では 3 件のエクスポートまたはメンバーが新たに非推奨になりました。

GET https://vigia.coredls.cloud/v1/packages/npm/node-fetch/upgrade?from=2.7.0&to=3.3.2