Skip to content

Commit d020f7d

Browse files
manu4543manu4543
committed
Parameter name change docs update
1 parent 868698f commit d020f7d

File tree

3 files changed

+102
-96
lines changed

3 files changed

+102
-96
lines changed

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+

‎README.md‎

Lines changed: 57 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ var imageURL = imagekit.url({
4545
path : "/default-image.jpg",
4646
urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/endpoint/",
4747
transformation : [{
48-
"HEIGHT" : "300",
49-
"WIDTH" : "400"
48+
"height" : "300",
49+
"width" : "400"
5050
}]
5151
});
5252
```
@@ -66,8 +66,8 @@ This method allows you to add transformation parameters to an existing, complete
6666
var imageURL = imagekit.url({
6767
src : "https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg",
6868
transformation : [{
69-
"HEIGHT" : "300",
70-
"WIDTH" : "400"
69+
"height" : "300",
70+
"width" : "400"
7171
}]
7272
});
7373
```
@@ -98,10 +98,10 @@ var imageURL = imagekit.url({
9898
path : "/default-image.jpg",
9999
urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/endpoint/",
100100
transformation : [{
101-
"HEIGHT" : "300",
102-
"WIDTH" : "400"
101+
"height" : "300",
102+
"width" : "400"
103103
}, {
104-
"ROTATION" : 90
104+
"rotation" : 90
105105
}],
106106
transformationPosition : "query"
107107
});
@@ -118,10 +118,10 @@ There are some transforms like [Sharpening](https://docs.imagekit.io/imagekit-do
118118
var imageURL = imagekit.url({
119119
src : "https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg",
120120
transformation : [{
121-
"FORMAT" : "jpg",
122-
"PROGRESSIVE" : "true",
123-
"EFFECT_SHARPEN" : "-",
124-
"EFFECT_CONTRAST" : "1"
121+
"format" : "jpg",
122+
"progressive" : "true",
123+
"effectSharpen" : "-",
124+
"effectContrast" : "1"
125125
}]
126126
});
127127
```
@@ -136,48 +136,48 @@ The complete list of transformations supported and their usage in ImageKit can b
136136

137137
| Supported Transformation Name | Translates to parameter |
138138
|-------------------------------|-------------------------|
139-
| HEIGHT | h |
140-
| WIDTH | w |
141-
| ASPECT_RATIO | ar |
142-
| QUALITY | q |
143-
| CROP | c |
144-
| CROP_MODE | cm |
145-
| X | x |
146-
| Y | y |
147-
| FOCUS | fo |
148-
| FORMAT | f |
149-
| RADIUS | r |
150-
| BACKGROUND | bg |
151-
| BORDER | bo |
152-
| ROTATION | rt |
153-
| BLUR | bl |
154-
| NAMED | n |
155-
| OVERLAY_IMAGE | oi |
156-
| OVERLAY_X | ox |
157-
| OVERLAY_Y | oy |
158-
| OVERLAY_FOCUS | ofo |
159-
| OVERLAY_HEIGHT | oh |
160-
| OVERLAY_WIDTH | ow |
161-
| OVERLAY_TEXT | ot |
162-
| OVERLAY_TEXT_FONT_SIZE | ots |
163-
| OVERLAY_TEXT_FONT_FAMILY | otf |
164-
| OVERLAY_TEXT_COLOR | otc |
165-
| OVERLAY_ALPHA | oa |
166-
| OVERLAY_TEXT_TYPOGRAPHY | ott |
167-
| OVERLAY_BACKGROUND | obg |
168-
| OVERLAY_IMAGE_TRIM | oit |
169-
| PROGRESSIVE | pr |
170-
| LOSSLESS | lo |
171-
| TRIM | t |
172-
| METADATA | md |
173-
| COLOR_PROFILE | cp |
174-
| DEFAULT_IMAGE | di |
175-
| DPR | dpr |
176-
| EFFECT_SHARPEN | e-sharpen |
177-
| EFFECT_USM | e-usm |
178-
| EFFECT_CONTRAST | e-contrast |
179-
| EFFECT_GRAY | e-grayscale |
180-
| ORIGINAL | orig |
139+
| height | h |
140+
| width | w |
141+
| aspectRatio | ar |
142+
| quality | q |
143+
| crop | c |
144+
| cropMode | cm |
145+
| x | x |
146+
| y | y |
147+
| focus | fo |
148+
| format | f |
149+
| radius | r |
150+
| background | bg |
151+
| border | bo |
152+
| rotation | rt |
153+
| blur | bl |
154+
| named | n |
155+
| overlayImage | oi |
156+
| overlayX | ox |
157+
| overlayY | oy |
158+
| overlayFocus | ofo |
159+
| overlayHeight | oh |
160+
| overlayWidth | ow |
161+
| overlayText | ot |
162+
| overlayTextFontSize | ots |
163+
| overlayTextFontFamily | otf |
164+
| overlayTextColor | otc |
165+
| overlayAlpha | oa |
166+
| overlayTextTypography | ott |
167+
| overlayBackground | obg |
168+
| overlayImageTrim | oit |
169+
| progressive | pr |
170+
| lossless | lo |
171+
| trim | t |
172+
| metadata | md |
173+
| colorProfile | cp |
174+
| defaultImage | di |
175+
| dpr | dpr |
176+
| effectSharpen | e-sharpen |
177+
| effectUSM | e-usm |
178+
| effectContrast | e-contrast |
179+
| effectGray | e-grayscale |
180+
| original | orig |
181181

182182

183183
### File Upload
@@ -218,7 +218,10 @@ Sample usage
218218
console.log(arguments);
219219
console.log(imagekit.url({
220220
src: result.url,
221-
transformation : [{ HEIGHT: 300, WIDTH: 400}]
221+
transformation : [{
222+
height: 300,
223+
width: 400
224+
}]
222225
}));
223226
});
224227
}

‎constants/supportedTransforms.js‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
module.exports = {
2-
"HEIGHT" : "h",
3-
"WIDTH" : "w",
4-
"ASPECT_RATIO" : "ar",
5-
"QUALITY" : "q",
6-
"CROP" : "c",
7-
"CROP_MODE" : "cm",
8-
"X" : "x",
9-
"Y" : "y",
10-
"FOCUS" : "fo",
11-
"FORMAT" : "f",
12-
"RADIUS" : "r",
13-
"BACKGROUND" : "bg",
14-
"BORDER" : "bo",
15-
"ROTATION" : "rt",
16-
"BLUR" : "bl",
17-
"NAMED" : "n",
18-
"OVERLAY_IMAGE" : "oi",
19-
"OVERLAY_X" : "ox",
20-
"OVERLAY_Y" : "oy",
21-
"OVERLAY_FOCUS" : "ofo",
22-
"OVERLAY_HEIGHT" : "oh",
23-
"OVERLAY_WIDTH" : "ow",
24-
"OVERLAY_TEXT" : "ot",
25-
"OVERLAY_TEXT_FONT_SIZE" : "ots",
26-
"OVERLAY_TEXT_FONT_FAMILY" : "otf",
27-
"OVERLAY_TEXT_COLOR" : "otc",
28-
"OVERLAY_ALPHA" : "oa",
29-
"OVERLAY_TEXT_TYPOGRAPHY" : "ott",
30-
"OVERLAY_BACKGROUND" : "obg",
31-
"OVERLAY_IMAGE_TRIM" : "oit",
32-
"PROGRESSIVE" : "pr",
33-
"LOSSLESS" : "lo",
34-
"TRIM" : "t",
35-
"METADATA" : "md",
36-
"COLOR_PROFILE" : "cp",
37-
"DEFAULT_IMAGE" : "di",
38-
"DPR" : "dpr",
39-
"EFFECT_SHARPEN" : "e-sharpen",
40-
"EFFECT_USM" : "e-usm",
41-
"EFFECT_CONTRAST" : "e-contrast",
42-
"EFFECT_GRAY" : "e-grayscale",
43-
"ORIGINAL" : "orig"
2+
"height" : "h",
3+
"width" : "w",
4+
"aspectRatio" : "ar",
5+
"quality" : "q",
6+
"crop" : "c",
7+
"cropMode" : "cm",
8+
"x" : "x",
9+
"y" : "y",
10+
"focus" : "fo",
11+
"format" : "f",
12+
"radius" : "r",
13+
"background" : "bg",
14+
"border" : "bo",
15+
"rotation" : "rt",
16+
"blur" : "bl",
17+
"named" : "n",
18+
"overlayImage" : "oi",
19+
"overlayX" : "ox",
20+
"overlayY" : "oy",
21+
"overlayFocus" : "ofo",
22+
"overlayHeight" : "oh",
23+
"overlayWidth" : "ow",
24+
"overlayText" : "ot",
25+
"overlayTextFontSize" : "ots",
26+
"overlayTextFontFamily" : "otf",
27+
"overlayTextColor" : "otc",
28+
"overlayAlpha" : "oa",
29+
"overlayTextTypography" : "ott",
30+
"overlayBackground" : "obg",
31+
"overlayImageTrim" : "oit",
32+
"progressive" : "pr",
33+
"lossless" : "lo",
34+
"trim" : "t",
35+
"metadata" : "md",
36+
"colorProfile" : "cp",
37+
"defaultImage" : "di",
38+
"dpr" : "dpr",
39+
"effectSharpen" : "e-sharpen",
40+
"effectUSM" : "e-usm",
41+
"effectContrast" : "e-contrast",
42+
"effectGray" : "e-grayscale",
43+
"original" : "orig"
4444
};

0 commit comments

Comments
 (0)