Upgrading ts-api-utils from 1.x to 2.x

Comparison of the public API of ts-api-utils 1.4.3 and 2.5.0, 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	6
Changed signatures	3
Removed class or interface members	0
Changed class or interface members	0
Newly deprecated	4
Requirement changes (engines, peer dependencies)	2
New exports	6

Removed exports

import	export	kind	Before
`ts-api-utils`	`isInputFiles`	function	`(node: ts.Node): node is ts.InputFiles`
`ts-api-utils`	`isUnparsedPrologue`	function	`(node: ts.Node): node is ts.UnparsedPrologue`
`ts-api-utils`	`isUnknownLiteralType`	function	`(type: ts.Type): type is UnknownLiteralType`
`ts-api-utils`	`isUnparsedSourceText`	function	`(node: ts.Node): node is ts.UnparsedSourceText`
`ts-api-utils`	`isUnparsedSyntheticReference`	function	`(node: ts.Node): node is ts.UnparsedSyntheticReference`
`ts-api-utils`	`isTransientSymbolLinksFlagSet`	function	`(links: ts.TransientSymbolLinks, flag: ts.CheckFlags): boolean`

Changed signatures

export	Before	After
`ts-api-utils · typeParts`	`(type: ts.Type): ts.Type[]`	`(type: ts.Type): ts.Type[]`
`ts-api-utils · unionTypeParts`	`(type: ts.Type): ts.Type[]`	`(type: ts.Type): ts.Type[]`
`ts-api-utils · intersectionTypeParts`	`(type: ts.Type): ts.Type[]`	`(type: ts.Type): ts.Type[]`

Removed class or interface members

None detected.

Changed class or interface members

None detected.

Newly deprecated

export	@deprecated
`ts-api-utils · typeParts`	Use {@link typeConstituents} instead.
`ts-api-utils · unionTypeParts`	Use {@link unionConstituents} instead.
`ts-api-utils · intersectionTypeParts`	Use {@link intersectionConstituents} instead.
`ts-api-utils · symbolHasReadonlyDeclaration`	This is not used by any consumers known by ts-api-utils, and so the public export will be removed in a future major version.

Requirement changes (engines, peer dependencies)

	Before	After
`engines.node`	`>=16`	`>=18.12`
`peerDependencies.typescript`	`>=4.2.0`	`>=4.8.4`

New exports (6)

import	export	kind
`ts-api-utils`	`Comment`	type
`ts-api-utils`	`iterateTokens`	function
`ts-api-utils`	`iterateComments`	function
`ts-api-utils`	`typeConstituents`	function
`ts-api-utils`	`unionConstituents`	function
`ts-api-utils`	`intersectionConstituents`	function

Frequently asked questions

What are the breaking changes when upgrading ts-api-utils from 1 to 2?

Between ts-api-utils 1.4.3 and 2.5.0, Vigia found 6 removed exports, 3 changed signatures and 0 removed or changed class or interface members.

What became deprecated in ts-api-utils 2?

4 exports or members are newly marked as deprecated in ts-api-utils 2.5.0.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/ts-api-utils/upgrade?from=1.4.3&to=2.5.0