Skip to content

Commit b7018e2

Browse files
committed
refactor: rename signal to abortSignal in upload options and update JSDoc
1 parent aae9934 commit b7018e2

File tree

6 files changed

+199
-149
lines changed

6 files changed

+199
-149
lines changed

src/interfaces/SrcOptions.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ import { TransformationPosition } from ".";
33

44
export interface SrcOptions {
55
/**
6-
* Accepts relative or absolute path of the resource. If relative path is provided, it is appended to the `urlEndpoint`. If absolute path is provided, `urlEndpoint` is ignored.
6+
* Accepts a relative or absolute path of the resource. If a relative path is provided, it is appended to the `urlEndpoint`.
7+
* If an absolute path is provided, `urlEndpoint` is ignored.
78
*/
89
src: string;
910

@@ -20,14 +21,15 @@ export interface SrcOptions {
2021
transformation?: Array<Transformation>;
2122

2223
/**
23-
* These are the other query parameters that you want to add to the final URL.
24-
* These can be any query parameters and not necessarily related to ImageKit.
25-
* Especially useful, if you want to add some versioning parameter to your URLs.
24+
* These are additional query parameters that you want to add to the final URL.
25+
* They can be any query parameters and not necessarily related to ImageKit.
26+
* This is especially useful if you want to add a versioning parameter to your URLs.
2627
*/
2728
queryParameters?: { [key: string]: string | number };
2829

2930
/**
30-
* By default, the transformation string is added as a query parameter in the URL e.g. `?tr=w-100,h-100`. If you want to add the transformation string in the path of the URL, set this to `path`.
31-
*/
31+
* By default, the transformation string is added as a query parameter in the URL, e.g., `?tr=w-100,h-100`.
32+
* If you want to add the transformation string in the path of the URL, set this to `path`.
33+
*/
3234
transformationPosition?: TransformationPosition;
33-
}
35+
}

0 commit comments

Comments
 (0)