Vigia

Upgrading flat-cache from 5.x to 6.x

Comparison of the public API of flat-cache 5.0.0 and 6.1.23, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.

Summary

Removed import paths0
Removed exports2
Changed signatures4
Removed class or interface members0
Changed class or interface members0
Newly deprecated0
Requirement changes (engines, peer dependencies)1
New exports4

Removed exports

importexportkindBefore
flat-cacheloadfunction(cacheId: string, cacheDir?: string | undefined): Cache
flat-cacheCacheinterfaceinterface

Changed signatures

exportBeforeAfter
flat-cache · create(cacheId: string, cacheDir?: string | undefined): Cache(options?: FlatCacheOptions | undefined): FlatCache
flat-cache · clearAll(cacheDir?: string | undefined): boolean(cacheDirectory?: string | undefined): void
flat-cache · clearCacheById(cacheId: string, cacheDir?: string | undefined): boolean(cacheId: string, cacheDirectory?: string | undefined): void
flat-cache · createFromFile(filePath: string): Cache(filePath: string, options?: FlatCacheOptions | undefined): FlatCache

Removed class or interface members

None detected.

Changed class or interface members

None detected.

Newly deprecated

None detected.

Requirement changes (engines, peer dependencies)

BeforeAfter
engines.node>=18—
New exports (4)
importexportkind
flat-cachedefaultclass
flat-cacheFlatCacheclass
flat-cacheFlatCacheEventsenum
flat-cacheFlatCacheOptionstype

Frequently asked questions

What are the breaking changes when upgrading flat-cache from 5 to 6?

Between flat-cache 5.0.0 and 6.1.23, Vigia found 2 removed exports, 4 changed signatures and 0 removed or changed class or interface members.

What became deprecated in flat-cache 6?

0 exports or members are newly marked as deprecated in flat-cache 6.1.23.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/flat-cache/upgrade?from=5.0.0&to=6.1.23