Beignet API reference
Preparing search index...
@beignet/core
uploads
UploadRouter
Interface UploadRouter
Framework-neutral upload router.
interface
UploadRouter
{
complete
(
uploadName
:
string
,
input
:
CompleteUploadInput
,
)
:
Promise
<
CompleteUploadResult
<
unknown
>
>
;
handleRequest
(
request
:
Request
,
options
:
{
action
:
"upload"
|
"prepare"
|
"complete"
;
uploadName
:
string
}
,
)
:
Promise
<
Response
>
;
prepare
(
uploadName
:
string
,
input
:
PrepareUploadInput
,
)
:
Promise
<
PrepareUploadResult
>
;
upload
(
uploadName
:
string
,
input
:
ServerUploadInput
,
)
:
Promise
<
CompleteUploadResult
<
unknown
>
>
;
}
Index
Methods
complete
handle
Request
prepare
upload
Methods
complete
complete
(
uploadName
:
string
,
input
:
CompleteUploadInput
,
)
:
Promise
<
CompleteUploadResult
<
unknown
>
>
Parameters
uploadName
:
string
input
:
CompleteUploadInput
Returns
Promise
<
CompleteUploadResult
<
unknown
>
>
handle
Request
handleRequest
(
request
:
Request
,
options
:
{
action
:
"upload"
|
"prepare"
|
"complete"
;
uploadName
:
string
}
,
)
:
Promise
<
Response
>
Parameters
request
:
Request
options
:
{
action
:
"upload"
|
"prepare"
|
"complete"
;
uploadName
:
string
}
Returns
Promise
<
Response
>
prepare
prepare
(
uploadName
:
string
,
input
:
PrepareUploadInput
,
)
:
Promise
<
PrepareUploadResult
>
Parameters
uploadName
:
string
input
:
PrepareUploadInput
Returns
Promise
<
PrepareUploadResult
>
upload
upload
(
uploadName
:
string
,
input
:
ServerUploadInput
,
)
:
Promise
<
CompleteUploadResult
<
unknown
>
>
Parameters
uploadName
:
string
input
:
ServerUploadInput
Returns
Promise
<
CompleteUploadResult
<
unknown
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
complete
handle
Request
prepare
upload
Beignet API reference
Loading...
Framework-neutral upload router.