Skip to content

Commit 33fd9cc

Browse files
committed
chore: update CHANGELOG for version 5.0.0 with breaking changes and new features
1 parent 69b4f50 commit 33fd9cc

File tree

2 files changed

+6737
-0
lines changed

2 files changed

+6737
-0
lines changed

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Changelog
22

3+
## Version 5.0.0
4+
5+
This version introduces major breaking changes, for usage examples, refer to the [official documentation](https://imagekit.io/docs/integration/javascript).
6+
7+
1. The package has been renamed from `imagekit-javascript` to `@imagekit/javascript`.
8+
Please update your dependency references and import statements accordingly.
9+
10+
2. The default-exported `ImageKit` class has been removed and replaced with named exports:
11+
- `buildSrc`
12+
- `buildTransformationString`
13+
- `upload`
14+
- Error classes: `ImageKitInvalidRequestError`, `ImageKitAbortError`, `ImageKitUploadNetworkError`, `ImageKitServerError`
15+
16+
Update your imports to use these named exports.
17+
18+
3. The `upload` method supports `AbortSignal` for canceling uploads.
19+
Upload error handling has been revamped, and `onProgress` callbacks are now supported.
20+
Only the Promise-based syntax is supported. Callback style usage has been removed.
21+
22+
4. Several internal interfaces (e.g., `ImageKitOptions`, `IKResponse`) have been updated or removed.
23+
The upload options now require a `publicKey`, and a new `SrcOptions` interface has been introduced.
24+
25+
---
26+
327
## Version 4.0.1
428

529
### Bug Fixes

0 commit comments

Comments
 (0)