Skip to content

fix: type defs for stream upload methods #336

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 2 commits into from
Feb 24, 2020
Merged

fix: type defs for stream upload methods #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d5103f
fix: type defs for stream upload methods
Jan 21, 2020
41bc0ef
test: update upload_stream testcase to expect UploadStream type
Jan 23, 2020
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
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"typescript": "^2.9.2"
},
"devDependencies": {
"@types/node": "^13.5.0",
"babel-cli": "^6.26.0",
"babel-core": "^6.26.3",
"babel-plugin-transform-runtime": "^6.23.0",
Expand Down
2 changes: 1 addition & 1 deletion types/cloudinary_ts_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,7 +764,7 @@ cloudinary.v2.uploader.remove_tag('12', ['11'], function (err, res) {
console.log(err, res);
});

// $ExpectType Promise<any>
// $ExpectType UploadStream
cloudinary.v2.uploader.upload_stream(
{template: "http://www.example.com/images/"},
function (error, result) {
Expand Down
16 changes: 11 additions & 5 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import { Transform } from 'stream';


declare module 'cloudinary' {

/****************************** Constants *************************************/
Expand Down Expand Up @@ -531,6 +534,9 @@ declare module 'cloudinary' {
type TargetArchiveFormat = string | "zip" | "tgz";
type ErrorCallBack = (error: any, result: any) => any;

class UploadStream extends Transform {
}

export namespace v2 {

/****************************** Global Utils *************************************/
Expand Down Expand Up @@ -819,9 +825,9 @@ declare module 'cloudinary' {

function unsigned_upload(file: string, upload_preset: string, callback?: ErrorCallBack): Promise<any>;

function unsigned_upload_stream(upload_preset: string, options?: UploadApiOptions, callback?: ErrorCallBack): Promise<any>;
function unsigned_upload_stream(upload_preset: string, options?: UploadApiOptions, callback?: ErrorCallBack): UploadStream;

function unsigned_upload_stream(upload_preset: string, callback?: ErrorCallBack): Promise<any>;
function unsigned_upload_stream(upload_preset: string, callback?: ErrorCallBack): UploadStream;

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

Expand All @@ -831,15 +837,15 @@ declare module 'cloudinary' {

function upload_chunked(path: string, callback?: ErrorCallBack): Promise<any>;

function upload_chunked_stream(options?: UploadApiOptions, callback?: ErrorCallBack): Promise<any>;
function upload_chunked_stream(options?: UploadApiOptions, callback?: ErrorCallBack): UploadStream;

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

function upload_large(path: string, callback?: ErrorCallBack): Promise<any>;

function upload_stream(options?: UploadApiOptions, callback?: ErrorCallBack): Promise<any>;
function upload_stream(options?: UploadApiOptions, callback?: ErrorCallBack): UploadStream;

function upload_stream(callback?: ErrorCallBack): Promise<any>;
function upload_stream(callback?: ErrorCallBack): UploadStream;

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

Expand Down