Skip to content

Commit 67354d6

Browse files
committed
type variable name change
1 parent f8ebabe commit 67354d6

File tree

4 files changed

+37
-37
lines changed

4 files changed

+37
-37
lines changed

index.ts

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
CopyFolderError,
1010
CopyFolderResponse,
1111
FileDetailsOptions,
12-
FileDetailsResponse,
12+
FileObject,
1313
FileMetadataResponse,
1414
ImageKitOptions,
1515
ListFileOptions,
@@ -134,13 +134,13 @@ class ImageKit {
134134
*
135135
* @param listFilesOptions
136136
*/
137-
listFiles(listOptions: ListFileOptions): Promise<FileDetailsResponse[]>;
138-
listFiles(listOptions: ListFileOptions, callback: IKCallback<FileDetailsResponse[]>): void;
137+
listFiles(listOptions: ListFileOptions): Promise<FileObject[]>;
138+
listFiles(listOptions: ListFileOptions, callback: IKCallback<FileObject[]>): void;
139139
listFiles(
140140
listOptions: ListFileOptions,
141-
callback?: IKCallback<FileDetailsResponse[]>,
142-
): void | Promise<FileDetailsResponse[]> {
143-
return promisify<FileDetailsResponse[]>(this, manage.listFiles)(listOptions, this.options, callback);
141+
callback?: IKCallback<FileObject[]>,
142+
): void | Promise<FileObject[]> {
143+
return promisify<FileObject[]>(this, manage.listFiles)(listOptions, this.options, callback);
144144
}
145145

146146
/**
@@ -150,10 +150,10 @@ class ImageKit {
150150
*
151151
* @param fileId
152152
*/
153-
getFileDetails(fileId: string): Promise<FileDetailsResponse>;
154-
getFileDetails(fileId: string, callback: IKCallback<FileDetailsResponse>): void;
155-
getFileDetails(fileId: string, callback?: IKCallback<FileDetailsResponse>): void | Promise<FileDetailsResponse> {
156-
return promisify<FileDetailsResponse>(this, manage.getFileDetails)(fileId, this.options, callback);
153+
getFileDetails(fileId: string): Promise<FileObject>;
154+
getFileDetails(fileId: string, callback: IKCallback<FileObject>): void;
155+
getFileDetails(fileId: string, callback?: IKCallback<FileObject>): void | Promise<FileObject> {
156+
return promisify<FileObject>(this, manage.getFileDetails)(fileId, this.options, callback);
157157
}
158158

159159
/**
@@ -163,10 +163,10 @@ class ImageKit {
163163
*
164164
* @param fileId
165165
*/
166-
getFileVersions(fileId: string): Promise<FileDetailsResponse>;
167-
getFileVersions(fileId: string, callback: IKCallback<FileDetailsResponse>): void;
168-
getFileVersions(fileId: string, callback?: IKCallback<FileDetailsResponse>): void | Promise<FileDetailsResponse> {
169-
return promisify<FileDetailsResponse>(this, manage.getFileVersions)(fileId, this.options, callback);
166+
getFileVersions(fileId: string): Promise<FileObject>;
167+
getFileVersions(fileId: string, callback: IKCallback<FileObject>): void;
168+
getFileVersions(fileId: string, callback?: IKCallback<FileObject>): void | Promise<FileObject> {
169+
return promisify<FileObject>(this, manage.getFileVersions)(fileId, this.options, callback);
170170
}
171171

172172
/**
@@ -176,10 +176,10 @@ class ImageKit {
176176
*
177177
* @param fileVersionDetailsOptions
178178
*/
179-
getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions): Promise<FileDetailsResponse>;
180-
getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions, callback: IKCallback<FileDetailsResponse>): void;
181-
getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions, callback?: IKCallback<FileDetailsResponse>): void | Promise<FileDetailsResponse> {
182-
return promisify<FileDetailsResponse>(this, manage.getFileVersionDetails)(fileVersionDetailsOptions, this.options, callback);
179+
getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions): Promise<FileObject>;
180+
getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions, callback: IKCallback<FileObject>): void;
181+
getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions, callback?: IKCallback<FileObject>): void | Promise<FileObject> {
182+
return promisify<FileObject>(this, manage.getFileVersionDetails)(fileVersionDetailsOptions, this.options, callback);
183183
}
184184

185185
/**
@@ -203,14 +203,14 @@ class ImageKit {
203203
* @param fileId The unique fileId of the uploaded file. fileId is returned in list files API and upload API.
204204
* @param updateData
205205
*/
206-
updateFileDetails(fileId: string, updateData: FileDetailsOptions): Promise<FileDetailsResponse>;
207-
updateFileDetails(fileId: string, updateData: FileDetailsOptions, callback: IKCallback<FileDetailsResponse>): void;
206+
updateFileDetails(fileId: string, updateData: FileDetailsOptions): Promise<FileObject>;
207+
updateFileDetails(fileId: string, updateData: FileDetailsOptions, callback: IKCallback<FileObject>): void;
208208
updateFileDetails(
209209
fileId: string,
210210
updateData: FileDetailsOptions,
211-
callback?: IKCallback<FileDetailsResponse>,
212-
): void | Promise<FileDetailsResponse> {
213-
return promisify<FileDetailsResponse>(this, manage.updateFileDetails)(fileId, updateData, this.options, callback);
211+
callback?: IKCallback<FileObject>,
212+
): void | Promise<FileObject> {
213+
return promisify<FileObject>(this, manage.updateFileDetails)(fileId, updateData, this.options, callback);
214214
}
215215

216216
/**
@@ -288,10 +288,10 @@ class ImageKit {
288288
*
289289
* @param restoreFileVersionOptions
290290
*/
291-
restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions): Promise<FileDetailsResponse>;
292-
restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions, callback: IKCallback<FileDetailsResponse>): void;
293-
restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions, callback?: IKCallback<FileDetailsResponse>): void | Promise<FileDetailsResponse> {
294-
return promisify<FileDetailsResponse>(this, manage.restoreFileVersion)(restoreFileVersionOptions, this.options, callback);
291+
restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions): Promise<FileObject>;
292+
restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions, callback: IKCallback<FileObject>): void;
293+
restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions, callback?: IKCallback<FileObject>): void | Promise<FileObject> {
294+
return promisify<FileObject>(this, manage.restoreFileVersion)(restoreFileVersionOptions, this.options, callback);
295295
}
296296

297297
/**

libs/interfaces/FileDetails.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface FileDetailsOptions {
4040
*
4141
* @see {@link https://docs.imagekit.io/api-reference/media-api#file-object-structure}
4242
*/
43-
export interface FileDetailsResponse {
43+
export interface FileObject {
4444
/**
4545
* The unique fileId of the uploaded file.
4646
*/

libs/interfaces/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { ListFileOptions, ListFileResponse } from "./ListFile";
88
import { CopyFileOptions } from "./CopyFile";
99
import { MoveFileOptions } from "./MoveFile";
1010
import { CreateFolderOptions } from "./CreateFolder";
11-
import { FileDetailsOptions, FileVersionDetailsOptions, FileDetailsResponse } from "./FileDetails";
11+
import { FileDetailsOptions, FileVersionDetailsOptions, FileObject } from "./FileDetails";
1212
import { FileMetadataResponse } from "./FileMetadata";
1313
import { PurgeCacheResponse, PurgeCacheStatusResponse } from "./PurgeCache";
1414
import { BulkDeleteFilesResponse, BulkDeleteFilesError } from "./BulkDeleteFiles";
@@ -33,7 +33,7 @@ export {
3333
ListFileResponse,
3434
FileDetailsOptions,
3535
FileVersionDetailsOptions,
36-
FileDetailsResponse,
36+
FileObject,
3737
FileMetadataResponse,
3838
PurgeCacheResponse,
3939
PurgeCacheStatusResponse,

libs/manage/file.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
ListFileResponse,
2222
FileDetailsOptions,
2323
FileVersionDetailsOptions,
24-
FileDetailsResponse,
24+
FileObject,
2525
FileMetadataResponse,
2626
BulkDeleteFilesResponse,
2727
BulkDeleteFilesError,
@@ -86,7 +86,7 @@ const deleteFileVersion = function (deleteFileVersionOptions: DeleteFileVersionO
8686
const restoreFileVersion = function (
8787
restoreFileVersionOptions: RestoreFileVersionOptions,
8888
defaultOptions: ImageKitOptions,
89-
callback?: IKCallback<FileDetailsResponse>) {
89+
callback?: IKCallback<FileObject>) {
9090
const { fileId, versionId } = restoreFileVersionOptions || {};
9191
if (!fileId) {
9292
respond(true, errorMessages.FILE_ID_MISSING, callback);
@@ -141,7 +141,7 @@ const getMetadata = function (
141141
const getDetails = function (
142142
fileId: string,
143143
defaultOptions: ImageKitOptions,
144-
callback?: IKCallback<FileDetailsResponse>,
144+
callback?: IKCallback<FileObject>,
145145
) {
146146
if (!fileId) {
147147
respond(true, errorMessages.FILE_ID_MISSING, callback);
@@ -163,7 +163,7 @@ const getDetails = function (
163163
const getFileVersionDetails = function (
164164
fileDetailsOptions: FileVersionDetailsOptions,
165165
defaultOptions: ImageKitOptions,
166-
callback?: IKCallback<FileDetailsResponse>,
166+
callback?: IKCallback<FileObject>,
167167
) {
168168
const { fileId, versionId } = fileDetailsOptions || {};
169169
if (!fileId) {
@@ -191,7 +191,7 @@ const updateDetails = function (
191191
fileId: string,
192192
updateData: FileDetailsOptions,
193193
defaultOptions: ImageKitOptions,
194-
callback?: IKCallback<FileDetailsResponse>,
194+
callback?: IKCallback<FileObject>,
195195
) {
196196
if (!fileId) {
197197
respond(true, errorMessages.FILE_ID_MISSING, callback);
@@ -224,7 +224,7 @@ const updateDetails = function (
224224
const listFiles = function (
225225
listOptions: ListFileOptions,
226226
defaultOptions: ImageKitOptions,
227-
callback?: IKCallback<FileDetailsResponse[]>,
227+
callback?: IKCallback<FileObject[]>,
228228
) {
229229
if (listOptions && !_.isObject(listOptions)) {
230230
respond(true, errorMessages.INVALID_LIST_OPTIONS, callback);
@@ -251,7 +251,7 @@ const listFiles = function (
251251
const getFilesVersions = function (
252252
fileId: string,
253253
defaultOptions: ImageKitOptions,
254-
callback?: IKCallback<FileDetailsResponse[]>,
254+
callback?: IKCallback<FileObject[]>,
255255
) {
256256
if (!fileId) {
257257
respond(true, errorMessages.FILE_ID_MISSING, callback);

0 commit comments

Comments
 (0)