Upgrading keyv from 4.x to 5.x
Comparison of the public API of keyv 4.5.4 and 5.6.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 | 3 |
| Changed signatures | 3 |
| Removed class or interface members | 0 |
| Changed class or interface members | 0 |
| Newly deprecated | 0 |
| Requirement changes (engines, peer dependencies) | 0 |
| New exports | 11 |
Removed exports
| import | export | kind | Before |
|---|---|---|---|
keyv | Store | interface | interface |
keyv | Options | interface | interface |
keyv | prototype | variable | any |
Changed signatures
| export | Before | After |
|---|---|---|
keyv · StoredData | string | DeserializedData<Value> | undefined | Value | DeserializedData<Value> | undefined |
keyv · DeserializedData | interface | { value?: Value | undefined; expires?: number | undefined; } |
keyv · CompressionAdapter | interface | { compress(value: any, options?: any): Promise<any>; decompress(value: any, options?: any): Promise<any>; serialize<Value>(data: DeserializedData<Value>): string | Promise<string>; deserialize<Value>(data: string): DeserializedData<Value> | Promise<DeserializedData<Value> | undefined> | undefined; } |
Removed class or interface members
None detected.
Changed class or interface members
None detected.
Newly deprecated
None detected.
Requirement changes (engines, peer dependencies)
None detected.
New exports (11)
| import | export | kind |
|---|---|---|
keyv | Keyv | class |
keyv | default | class |
keyv | KeyvEntry | type |
keyv | KeyvHooks | enum |
keyv | Serialize | type |
keyv | Deserialize | type |
keyv | KeyvOptions | type |
keyv | IEventEmitter | type |
keyv | StoredDataRaw | type |
keyv | StoredDataNoRaw | type |
keyv | KeyvStoreAdapter | type |
Frequently asked questions
What are the breaking changes when upgrading keyv from 4 to 5?
Between keyv 4.5.4 and 5.6.0, Vigia found 3 removed exports, 3 changed signatures and 0 removed or changed class or interface members.
What became deprecated in keyv 5?
0 exports or members are newly marked as deprecated in keyv 5.6.0.
For agents
GET https://vigia.coredls.cloud/v1/packages/npm/keyv/upgrade?from=4.5.4&to=5.6.0