Skip to content

Added types for upload response callback #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2020
Merged

Added types for upload response callback #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions types/cloudinary_ts_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -681,13 +681,13 @@ cloudinary.v2.uploader.text("Sample text string",
font_weight: "bold"
});

// $ExpectType Promise<any>
// $ExpectType Promise<UploadApiResponse>
cloudinary.v2.uploader.upload("http://www.example.com/sample.jpg",
function (error, result) {
console.log(result, error);
});

// $ExpectType Promise<any>
// $ExpectType Promise<UploadApiResponse>
cloudinary.v2.uploader.upload("ftp://user1:mypass@ftp.example.com/sample.jpg",
{
eager: [
Expand All @@ -698,7 +698,7 @@ cloudinary.v2.uploader.upload("ftp://user1:mypass@ftp.example.com/sample.jpg",
console.log(result, error);
});

// $ExpectType Promise<any>
// $ExpectType Promise<UploadApiResponse>
cloudinary.v2.uploader.upload_large("my_large_video.mp4",
{
resource_type: "video",
Expand All @@ -707,7 +707,7 @@ cloudinary.v2.uploader.upload_large("my_large_video.mp4",
function (error, result) {console.log(result, error);
});

// $ExpectType Promise<any>
// $ExpectType Promise<UploadApiResponse>
cloudinary.v2.uploader.upload_large("my_large_video.mp4",
{resource_type: "video"},
function (error, result) {
Expand Down
59 changes: 48 additions & 11 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,44 @@ declare module 'cloudinary' {
type TargetArchiveFormat = string | "zip" | "tgz";

// err is kept for backwards compatibility, it currently will always be undefined
type ResponseCallback = (callResult: any, err?: any) => any;
type ResponseCallback = (err?: any, callResult?: any) => any;

type UploadResponseCallback = (err?: UploadApiErrorResponse, callResult?: UploadApiResponse) => void;

export interface UploadApiResponse {
public_id: string;
version: number;
signature: string;
width: number;
height: number;
format: string;
resource_type: string;
created_at: string;
tags: Array<string>;
pages: number;
bytes: number;
type: string;
etag: string;
placeholder: boolean;
url: string;
secure_url: string;
access_mode: string;
original_filename: string;
moderation: Array<string>;
access_control: Array<string>;
context: object;
metadata: object;

[futureKey: string]: any;
}

export interface UploadApiErrorResponse {
message: string;
name: string;
http_code: number;

[futureKey: string]: any;
}

class UploadStream extends Transform {
}
Expand Down Expand Up @@ -847,25 +884,25 @@ declare module 'cloudinary' {

function unsigned_upload_stream(upload_preset: string, callback?: ResponseCallback): UploadStream;

function upload(file: string, options?: UploadApiOptions, callback?: ResponseCallback): Promise<any>;
function upload(file: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;

function upload(file: string, callback?: ResponseCallback): Promise<any>;
function upload(file: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;

function upload_chunked(path: string, options?: UploadApiOptions, callback?: ResponseCallback): Promise<any>;
function upload_chunked(path: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;

function upload_chunked(path: string, callback?: ResponseCallback): Promise<any>;
function upload_chunked(path: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;

function upload_chunked_stream(options?: UploadApiOptions, callback?: ResponseCallback): UploadStream;
function upload_chunked_stream(options?: UploadApiOptions, callback?: UploadResponseCallback): UploadStream;

function upload_large(path: string, options?: UploadApiOptions, callback?: ResponseCallback): Promise<any>;
function upload_large(path: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;

function upload_large(path: string, callback?: ResponseCallback): Promise<any>;
function upload_large(path: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;

function upload_stream(options?: UploadApiOptions, callback?: ResponseCallback): UploadStream;
function upload_stream(options?: UploadApiOptions, callback?: UploadResponseCallback): UploadStream;

function upload_stream(callback?: ResponseCallback): UploadStream;
function upload_stream(callback?: UploadResponseCallback): UploadStream;

function upload_tag_params(options?: UploadApiOptions, callback?: ResponseCallback): Promise<any>;
function upload_tag_params(options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<any>;

function upload_url(options?: ConfigOptions): Promise<any>;
}
Expand Down