Upgrading minipass from 6.x to 7.x
Comparison of the public API of minipass 6.0.2 and 7.1.3, 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 | 1 |
| Changed class or interface members | 8 |
| Newly deprecated | 3 |
| Requirement changes (engines, peer dependencies) | 0 |
| New exports | 7 |
Removed exports
None detected.
Changed signatures
None detected.
Removed class or interface members
| member | import | Before |
|---|---|---|
Minipass.once | minipass | <Event extends keyof Events>(ev: Event, handler: (...args: Events[Event]) => any): Minipass<RType, WType, Events> |
Changed class or interface members
| member | Before | After |
|---|---|---|
Minipass.end | (cb?: (() => void) | undefined): Minipass<RType, WType, Events> | (chunk: any, cb?: (() => void) | undefined): Minipass<RType, WType, Events> | (chunk: any, encoding?: any, cb?: (() => void) | undefined): Minipass<RType, WType, Events> | (cb?: (() => void) | undefined): Minipass<RType, WType, Events> | (chunk: WType, cb?: (() => void) | undefined): Minipass<RType, WType, Events> | (chunk: WType, encoding?: any, cb?: (() => void) | undefined): Minipass<RType, WType, Events> |
Minipass.emit | <Event extends keyof Events>(ev: Event, ...data: Events[Event]): boolean | <Event extends keyof Events>(ev: Event, ...args: Events[Event]): boolean |
Minipass.read | (size?: number | undefined): RType | (n?: number | null | undefined): RType | null |
Minipass.concat | (): any | (): Promise<RType> |
Minipass.collect | (): Promise<RType[]> | (): Promise<RType[] & { dataLength: number; }> |
Minipass.destroy | (er?: any): void | (er?: unknown): Minipass<RType, WType, Events> |
Minipass.constructor | <RType extends unknown = Buffer, WType extends unknown = any, Events extends Minipass.Events<RType> = Events<RType>>(...args: RType extends Buffer ? [] | [Options<RType>] : [Options<RType>]): Minipass<RType, WType, Events> | <RType extends unknown = Buffer, WType extends unknown = any, Events extends Minipass.Events<RType> = Events<RType>>(...args: [ObjectModeOptions] | (RType extends Buffer ? [] | [Options<RType>] : [Options<RType>])): Minipass<RType, WType, Events> |
Minipass.static isStream | (stream: any): stream is any | (s: any): s is any |
Newly deprecated
| export | @deprecated |
|---|---|
minipass · Minipass.encoding | - This is a read only property |
minipass · Minipass.objectMode | - This is a read-only property |
minipass · Minipass.static isStream | — |
Requirement changes (engines, peer dependencies)
None detected.
New exports (7)
| import | export | kind |
|---|---|---|
minipass | SD | type |
minipass | Pipe | class |
minipass | isStream | variable |
minipass | isReadable | variable |
minipass | isWritable | variable |
minipass | PipeOptions | interface |
minipass | PipeProxyErrors | class |
Frequently asked questions
What are the breaking changes when upgrading minipass from 6 to 7?
Between minipass 6.0.2 and 7.1.3, Vigia found 0 removed exports, 0 changed signatures and 9 removed or changed class or interface members.
What became deprecated in minipass 7?
3 exports or members are newly marked as deprecated in minipass 7.1.3.
For agents
GET https://vigia.coredls.cloud/v1/packages/npm/minipass/upgrade?from=6.0.2&to=7.1.3