Upgrading readdirp from 4.x to 5.x
Comparison of the public API of readdirp 4.1.2 and 5.1.1, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.
Summary
| Removed import paths | 0 |
|---|---|
| Removed exports | 0 |
| Changed signatures | 0 |
| Removed class or interface members | 0 |
| Changed class or interface members | 5 |
| Newly deprecated | 0 |
| Requirement changes (engines, peer dependencies) | 1 |
| New exports | 0 |
Removed exports
None detected.
Changed signatures
None detected.
Removed class or interface members
None detected.
Changed class or interface members
| member | Before | After |
|---|---|---|
DirEntry.files | any[] | any[] | undefined |
ReaddirpStream.parents | any[] | PendingDir[] |
ReaddirpStream._exploreDir | (path: string, depth: number): Promise<{ files: string[] | undefined; depth: number; path: string; }> | (path: string, depth: number): Promise<DirEntry> |
ReaddirpStream._formatEntry | (dirent: any, path: string): Promise<EntryInfo | undefined> | (dirent: any, path: string): EntryInfo | Promise<EntryInfo | undefined> | undefined |
ReaddirpStream._getEntryType | (entry: EntryInfo): Promise<void | "" | "file" | "directory"> | (entry: EntryInfo): "" | "file" | "directory" | Promise<"" | "file" | "directory"> |
Newly deprecated
None detected.
Requirement changes (engines, peer dependencies)
| Before | After | |
|---|---|---|
engines.node | >= 14.18.0 | >= 20.19.0 |
Frequently asked questions
What are the breaking changes when upgrading readdirp from 4 to 5?
Between readdirp 4.1.2 and 5.1.1, Vigia found 0 removed exports, 0 changed signatures and 5 removed or changed class or interface members.
What became deprecated in readdirp 5?
0 exports or members are newly marked as deprecated in readdirp 5.1.1.
For agents
GET https://vigia.coredls.cloud/v1/packages/npm/readdirp/upgrade?from=4.1.2&to=5.1.1