Search
Preparing search index...
The search index is not available
@uploadcare/upload-client
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@uploadcare/upload-client
UploadClient
Class UploadClient
Hierarchy
UploadClient
Index
Constructors
constructor
Methods
base
from
Url
from
Url
Status
get
Settings
group
group
Info
info
multipart
Complete
multipart
Start
multipart
Upload
update
Settings
upload
File
upload
File
Group
Constructors
constructor
new
Upload
Client
(
settings
:
Settings
)
:
UploadClient
Parameters
settings:
Settings
Returns
UploadClient
Methods
base
base
(
file
:
SupportedFileInput
, options
?:
Partial
<
BaseOptions
>
)
:
Promise
<
BaseResponse
>
Parameters
file:
SupportedFileInput
options:
Partial
<
BaseOptions
>
= {}
Returns
Promise
<
BaseResponse
>
from
Url
from
Url
(
sourceUrl
:
string
, options
?:
Partial
<
FromUrlOptions
>
)
:
Promise
<
FromUrlSuccessResponse
>
Parameters
sourceUrl:
string
options:
Partial
<
FromUrlOptions
>
= {}
Returns
Promise
<
FromUrlSuccessResponse
>
from
Url
Status
from
Url
Status
(
token
:
string
, options
?:
Partial
<
FromUrlStatusOptions
>
)
:
Promise
<
FromUrlStatusResponse
>
Parameters
token:
string
options:
Partial
<
FromUrlStatusOptions
>
= {}
Returns
Promise
<
FromUrlStatusResponse
>
get
Settings
get
Settings
(
)
:
Settings
Returns
Settings
group
group
(
uuids
:
string
[]
, options
?:
Partial
<
GroupOptions
>
)
:
Promise
<
GroupInfo
>
Parameters
uuids:
string
[]
options:
Partial
<
GroupOptions
>
= {}
Returns
Promise
<
GroupInfo
>
group
Info
group
Info
(
id
:
string
, options
?:
Partial
<
GroupInfoOptions
>
)
:
Promise
<
GroupInfo
>
Parameters
id:
string
options:
Partial
<
GroupInfoOptions
>
= {}
Returns
Promise
<
GroupInfo
>
info
info
(
uuid
:
string
, options
?:
Partial
<
InfoOptions
>
)
:
Promise
<
FileInfo
>
Parameters
uuid:
string
options:
Partial
<
InfoOptions
>
= {}
Returns
Promise
<
FileInfo
>
multipart
Complete
multipart
Complete
(
uuid
:
string
, options
?:
Partial
<
MultipartCompleteOptions
>
)
:
Promise
<
FileInfo
>
Parameters
uuid:
string
options:
Partial
<
MultipartCompleteOptions
>
= {}
Returns
Promise
<
FileInfo
>
multipart
Start
multipart
Start
(
size
:
number
, options
?:
Partial
<
MultipartStartOptions
>
)
:
Promise
<
MultipartStartResponse
>
Parameters
size:
number
options:
Partial
<
MultipartStartOptions
>
= {}
Returns
Promise
<
MultipartStartResponse
>
multipart
Upload
multipart
Upload
(
part
:
Sliceable
, url
:
string
, options
?:
Partial
<
MultipartUploadOptions
>
)
:
Promise
<
MultipartUploadResponse
>
Parameters
part:
Sliceable
url:
string
options:
Partial
<
MultipartUploadOptions
>
= {}
Returns
Promise
<
MultipartUploadResponse
>
update
Settings
update
Settings
(
newSettings
:
Settings
)
:
void
Parameters
newSettings:
Settings
Returns
void
upload
File
upload
File
(
data
:
string
|
SupportedFileInput
, options
?:
Partial
<
FileFromOptions
>
)
:
Promise
<
UploadcareFile
>
Parameters
data:
string
|
SupportedFileInput
options:
Partial
<
FileFromOptions
>
= {}
Returns
Promise
<
UploadcareFile
>
upload
File
Group
upload
File
Group
(
data
:
string
[]
|
SupportedFileInput
[]
, options
?:
Partial
<
FileFromOptions
&
GroupFromOptions
>
)
:
Promise
<
UploadcareGroup
>
Parameters
data:
string
[]
|
SupportedFileInput
[]
options:
Partial
<
FileFromOptions
&
GroupFromOptions
>
= {}
Returns
Promise
<
UploadcareGroup
>
Exports
Upload
Client
constructor
base
from
Url
from
Url
Status
get
Settings
group
group
Info
info
multipart
Complete
multipart
Start
multipart
Upload
update
Settings
upload
File
upload
File
Group
Generated using
TypeDoc