Skip to content

Commit 8e4b1f5

Browse files
committed
chore: moved changelog to separate file
1 parent 28a3607 commit 8e4b1f5

File tree

2 files changed

+38
-39
lines changed

2 files changed

+38
-39
lines changed

CHANGELOG.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Changelog
2+
3+
### SDK Version 5.3.0
4+
5+
### Breaking changes
6+
7+
**1. `listFiles` API response type**
8+
* The `listFiles` method now returns a unified response type, ListFileResponse, which is an array of both `FileObject` and `FolderObject`. Previously, the response contained only `FileObject`. The `type` property in the response object indicates whether the object is a file or a folder. Even though this change has been made to just the type of the return object, it can be considered a breaking change so it may require require any code relying on the `listFiles` response to be updated.
9+
10+
```
11+
const result = await imagekit.listFiles({ skip: 0, limit: 10 });
12+
13+
# Before (Pre-version 5.3.0)
14+
result.forEach((item) => {
15+
console.log(item);
16+
});
17+
18+
# After (Version 5.3.0 and above)
19+
result.forEach((item) => {
20+
if (item.type === "folder") {
21+
console.log(item) // item is of type FolderObject
22+
} else {
23+
console.log(item) // item is of type FileObject
24+
}
25+
});
26+
```
27+
28+
29+
### SDK Version 5.0.0
30+
31+
#### Breaking changes
32+
33+
**1. Overlay syntax update**
34+
* In version 5.0.0, we've removed the old overlay syntax parameters for transformations, such as `oi`, `ot`, `obg`, and [more](https://docs.imagekit.io/features/image-transformations/overlay). These parameters are deprecated and will start returning errors when used in URLs. Please migrate to the new layers syntax that supports overlay nesting, provides better positional control, and allows more transformations at the layer level. You can start with [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples) to learn quickly.
35+
* You can migrate to the new layers syntax using the `raw` transformation parameter.
36+
37+
**2. Remove Node.js 10.x support**
38+
* In version 5.0.0, we've removed support for Node.js version 10.x.

README.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -25,45 +25,6 @@ ImageKit is complete media storage, optimization, and transformation solution th
2525
* [Support](#support)
2626
* [Links](#links)
2727

28-
## Changelog
29-
30-
### SDK Version 5.3.0
31-
32-
### Breaking changes
33-
34-
**1. `listFiles` API response type**
35-
* The `listFiles` method now returns a unified response type, ListFileResponse, which is an array of both `FileObject` and `FolderObject`. Previously, the response contained only `FileObject`. The `type` property in the response object indicates whether the object is a file or a folder. Even though this change has been made to just the type of the return object, it can be considered a breaking change so it may require require any code relying on the `listFiles` response to be updated.
36-
37-
```
38-
const result = await imagekit.listFiles({ skip: 0, limit: 10 });
39-
40-
# Before (Pre-version 5.3.0)
41-
result.forEach((item) => {
42-
console.log(item);
43-
});
44-
45-
# After (Version 5.3.0 and above)
46-
result.forEach((item) => {
47-
if (item.type === "folder") {
48-
console.log(item) // item is of type FolderObject
49-
} else {
50-
console.log(item) // item is of type FileObject
51-
}
52-
});
53-
```
54-
55-
56-
### SDK Version 5.0.0
57-
58-
#### Breaking changes
59-
60-
**1. Overlay syntax update**
61-
* In version 5.0.0, we've removed the old overlay syntax parameters for transformations, such as `oi`, `ot`, `obg`, and [more](https://docs.imagekit.io/features/image-transformations/overlay). These parameters are deprecated and will start returning errors when used in URLs. Please migrate to the new layers syntax that supports overlay nesting, provides better positional control, and allows more transformations at the layer level. You can start with [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples) to learn quickly.
62-
* You can migrate to the new layers syntax using the `raw` transformation parameter.
63-
64-
**2. Remove Node.js 10.x support**
65-
* In version 5.0.0, we've removed support for Node.js version 10.x.
66-
6728
## Installation
6829

6930
Use the following command to download this module. Use the optional `--save` parameter if you wish to save the dependency in your `package.json` file.

0 commit comments

Comments
 (0)