Preparing search index...
The search index is not available
@uploadcare/upload-client
@uploadcare/upload-client
UploadClient
Class UploadClient
Hierarchy
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
Upload
Client
(
settings
)
:
UploadClient
Parameters
settings
:
Settings
Returns
UploadClient
Methods
base
base
(
file
,
options
?
)
:
Promise
<
BaseResponse
>
Parameters
file
:
SupportedFileInput
options
:
Partial
<
BaseOptions
>
= {}
Returns
Promise
<
BaseResponse
>
from
Url
from
Url
(
sourceUrl
,
options
?
)
:
Promise
<
FromUrlSuccessResponse
>
Parameters
sourceUrl
:
string
options
:
Partial
<
FromUrlOptions
>
= {}
Returns
Promise
<
FromUrlSuccessResponse
>
from
Url
Status
from
Url
Status
(
token
,
options
?
)
:
Promise
<
FromUrlStatusResponse
>
Parameters
token
:
string
options
:
Partial
<
FromUrlStatusOptions
>
= {}
Returns
Promise
<
FromUrlStatusResponse
>
get
Settings
get
Settings
(
)
:
Settings
Returns
Settings
group
group
(
uuids
,
options
?
)
:
Promise
<
GroupInfo
>
Parameters
uuids
:
string
[]
options
:
Partial
<
GroupOptions
>
= {}
Returns
Promise
<
GroupInfo
>
group
Info
group
Info
(
id
,
options
?
)
:
Promise
<
GroupInfo
>
Parameters
id
:
string
options
:
Partial
<
GroupInfoOptions
>
= {}
Returns
Promise
<
GroupInfo
>
info
info
(
uuid
,
options
?
)
:
Promise
<
FileInfo
>
Parameters
uuid
:
string
options
:
Partial
<
InfoOptions
>
= {}
Returns
Promise
<
FileInfo
>
is
Ready
Poll
is
Ready
Poll
(
uuid
,
options
?
)
:
Promise
<
FileInfo
>
Parameters
uuid
:
string
options
:
Partial
<
IsReadyPoolOptions
>
= {}
Returns
Promise
<
FileInfo
>
multipart
Complete
multipart
Complete
(
uuid
,
options
?
)
:
Promise
<
FileInfo
>
Parameters
uuid
:
string
options
:
Partial
<
MultipartCompleteOptions
>
= {}
Returns
Promise
<
FileInfo
>
multipart
Start
multipart
Start
(
size
,
options
?
)
:
Promise
<
MultipartStartResponse
>
Parameters
size
:
number
options
:
Partial
<
MultipartStartOptions
>
= {}
Returns
Promise
<
MultipartStartResponse
>
multipart
Upload
multipart
Upload
(
part
,
url
,
options
?
)
:
Promise
<
MultipartUploadResponse
>
Parameters
part
:
Sliceable
url
:
string
options
:
Partial
<
MultipartUploadOptions
>
= {}
Returns
Promise
<
MultipartUploadResponse
>
update
Settings
update
Settings
(
newSettings
)
:
void
Parameters
newSettings
:
Settings
Returns
void
upload
File
upload
File
(
data
,
options
?
)
:
Promise
<
UploadcareFile
>
Parameters
data
:
string
|
SupportedFileInput
options
:
Partial
<
FileFromOptions
>
= {}
Returns
Promise
<
UploadcareFile
>
upload
File
Group
upload
File
Group
(
data
,
options
?
)
:
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
constructor
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
Status
Type
Enum
Cancel
Error
Network
Error
Queue
Upload
Client
Upload
Error
Uploadcare
Error
Uploadcare
File
Uploadcare
Group
Settings
Audio
Info
Base
Options
Base
Response
Browser
File
Computable
Progress
Info
Content
Info
Custom
User
Agent
Custom
User
Agent
Fn
Custom
User
Agent
Options
Direct
Options
Error
Request
Info
Error
Response
Info
File
From
Options
File
Info
File
Info
Response
From
Uploaded
Options
From
Url
Options
From
Url
Response
From
Url
Status
Options
From
Url
Status
Response
From
Url
Success
Response
Geo
Location
Get
User
Agent
Options
Group
File
Info
Group
From
Options
Group
Id
Group
Info
Group
Info
Options
Group
Options
Headers
Image
Info
Info
Options
Metadata
Mime
Info
Multipart
Complete
Options
Multipart
Options
Multipart
Part
Multipart
Start
Options
Multipart
Start
Response
Multipart
Upload
Options
Multipart
Upload
Response
Node
File
Progress
Callback
React
Native
Asset
Sliceable
Status
Error
Response
Status
Progress
Response
Status
Success
Response
Status
Unknown
Response
Status
Waiting
Response
Supported
File
Input
Token
Token
Response
Unknown
Progress
Info
Upload
From
Url
Options
Url
Uuid
Video
Info
Upload
Client
Error
Uploadcare
Network
Error
base
from
Url
from
Url
Status
get
User
Agent
group
group
Info
info
is
Ready
Poll
multipart
Complete
multipart
Start
multipart
Upload
upload
Direct
upload
File
upload
File
Group
upload
From
Uploaded
upload
From
Url
upload
Multipart
Generated using
TypeDoc