@uploadcare/upload-client
Preparing search index...
UploadClient
Class UploadClient
Index
Constructors
constructor
Methods
base
from
Url
from
Url
Status
get
Settings
group
group
Info
info
is
Ready
Poll
multipart
Complete
multipart
Start
multipart
Upload
update
Settings
upload
File
upload
File
Group
Constructors
constructor
new
UploadClient
(
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
fromUrl
(
sourceUrl
:
string
,
options
?:
Partial
<
FromUrlOptions
>
,
)
:
Promise
<
FromUrlSuccessResponse
>
Parameters
sourceUrl
:
string
options
:
Partial
<
FromUrlOptions
>
= {}
Returns
Promise
<
FromUrlSuccessResponse
>
from
Url
Status
fromUrlStatus
(
token
:
string
,
options
?:
Partial
<
FromUrlStatusOptions
>
,
)
:
Promise
<
FromUrlStatusResponse
>
Parameters
token
:
string
options
:
Partial
<
FromUrlStatusOptions
>
= {}
Returns
Promise
<
FromUrlStatusResponse
>
get
Settings
getSettings
()
:
Settings
Returns
Settings
group
group
(
uuids
:
string
[]
,
options
?:
Partial
<
GroupOptions
>
)
:
Promise
<
GroupInfo
>
Parameters
uuids
:
string
[]
options
:
Partial
<
GroupOptions
>
= {}
Returns
Promise
<
GroupInfo
>
group
Info
groupInfo
(
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
>
is
Ready
Poll
isReadyPoll
(
uuid
:
string
,
options
?:
Partial
<
IsReadyPoolOptions
>
,
)
:
Promise
<
FileInfo
>
Parameters
uuid
:
string
options
:
Partial
<
IsReadyPoolOptions
>
= {}
Returns
Promise
<
FileInfo
>
multipart
Complete
multipartComplete
(
uuid
:
string
,
options
?:
Partial
<
MultipartCompleteOptions
>
,
)
:
Promise
<
FileInfo
>
Parameters
uuid
:
string
options
:
Partial
<
MultipartCompleteOptions
>
= {}
Returns
Promise
<
FileInfo
>
multipart
Start
multipartStart
(
size
:
number
,
options
?:
Partial
<
MultipartStartOptions
>
,
)
:
Promise
<
MultipartStartResponse
>
Parameters
size
:
number
options
:
Partial
<
MultipartStartOptions
>
= {}
Returns
Promise
<
MultipartStartResponse
>
multipart
Upload
multipartUpload
(
part
:
Sliceable
,
url
:
string
,
options
?:
Partial
<
MultipartUploadOptions
>
,
)
:
Promise
<
MultipartUploadResponse
>
Parameters
part
:
Sliceable
url
:
string
options
:
Partial
<
MultipartUploadOptions
>
= {}
Returns
Promise
<
MultipartUploadResponse
>
update
Settings
updateSettings
(
newSettings
:
Settings
)
:
void
Parameters
newSettings
:
Settings
Returns
void
upload
File
uploadFile
(
data
:
string
|
SupportedFileInput
,
options
?:
Partial
<
FileFromOptions
>
,
)
:
Promise
<
UploadcareFile
>
Parameters
data
:
string
|
SupportedFileInput
options
:
Partial
<
FileFromOptions
>
= {}
Returns
Promise
<
UploadcareFile
>
upload
File
Group
uploadFileGroup
(
data
:
string
[]
|
SupportedFileInput
[]
,
options
?:
Partial
<
FileFromOptions
&
GroupFromOptions
>
,
)
:
Promise
<
UploadcareGroup
>
Parameters
data
:
string
[]
|
SupportedFileInput
[]
options
:
Partial
<
FileFromOptions
&
GroupFromOptions
>
= {}
Returns
Promise
<
UploadcareGroup
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
base
from
Url
from
Url
Status
get
Settings
group
group
Info
info
is
Ready
Poll
multipart
Complete
multipart
Start
multipart
Upload
update
Settings
upload
File
upload
File
Group
@uploadcare/upload-client
Loading...