@valon-technologies/gestalt
Preparing search index...
@valon-technologies/gestalt
S3ProviderOptions
Interface S3ProviderOptions
Runtime hooks required to implement a Gestalt S3 provider.
interface
S3ProviderOptions
{
name
?:
string
;
displayName
?:
string
;
description
?:
string
;
version
?:
string
;
configure
?:
ConfigureHandler
;
healthCheck
?:
HealthCheckHandler
;
warnings
?:
string
[]
|
WarningsHandler
;
start
?:
StartHandler
;
close
?:
CloseHandler
;
headObject
:
(
ref
:
ObjectRef
)
=>
MaybePromise
<
ObjectMeta
>
;
readObject
:
(
ref
:
ObjectRef
,
options
?:
ReadOptions
,
)
=>
MaybePromise
<
ProviderReadResult
>
;
writeObject
:
(
ref
:
ObjectRef
,
body
:
AsyncIterable
<
Uint8Array
<
ArrayBufferLike
>
>
,
options
?:
WriteOptions
,
)
=>
MaybePromise
<
ObjectMeta
>
;
deleteObject
:
(
ref
:
ObjectRef
)
=>
MaybePromise
<
void
>
;
listObjects
:
(
options
:
ListOptions
)
=>
MaybePromise
<
ListPage
>
;
copyObject
:
(
source
:
ObjectRef
,
destination
:
ObjectRef
,
options
?:
CopyOptions
,
)
=>
MaybePromise
<
ObjectMeta
>
;
presignObject
:
(
ref
:
ObjectRef
,
options
?:
PresignOptions
,
)
=>
MaybePromise
<
PresignResult
>
;
}
Hierarchy (
View Summary
)
RuntimeProviderOptions
S3ProviderOptions
Index
Properties
name?
display
Name?
description?
version?
configure?
health
Check?
warnings?
start?
close?
head
Object
read
Object
write
Object
delete
Object
list
Objects
copy
Object
presign
Object
Properties
Optional
name
name
?:
string
Optional
display
Name
displayName
?:
string
Optional
description
description
?:
string
Optional
version
version
?:
string
Optional
configure
configure
?:
ConfigureHandler
Optional
health
Check
healthCheck
?:
HealthCheckHandler
Optional
warnings
warnings
?:
string
[]
|
WarningsHandler
Optional
start
start
?:
StartHandler
Optional
close
close
?:
CloseHandler
head
Object
headObject
:
(
ref
:
ObjectRef
)
=>
MaybePromise
<
ObjectMeta
>
read
Object
readObject
:
(
ref
:
ObjectRef
,
options
?:
ReadOptions
,
)
=>
MaybePromise
<
ProviderReadResult
>
write
Object
writeObject
:
(
ref
:
ObjectRef
,
body
:
AsyncIterable
<
Uint8Array
<
ArrayBufferLike
>
>
,
options
?:
WriteOptions
,
)
=>
MaybePromise
<
ObjectMeta
>
delete
Object
deleteObject
:
(
ref
:
ObjectRef
)
=>
MaybePromise
<
void
>
list
Objects
listObjects
:
(
options
:
ListOptions
)
=>
MaybePromise
<
ListPage
>
copy
Object
copyObject
:
(
source
:
ObjectRef
,
destination
:
ObjectRef
,
options
?:
CopyOptions
,
)
=>
MaybePromise
<
ObjectMeta
>
presign
Object
presignObject
:
(
ref
:
ObjectRef
,
options
?:
PresignOptions
,
)
=>
MaybePromise
<
PresignResult
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
name
display
Name
description
version
configure
health
Check
warnings
start
close
head
Object
read
Object
write
Object
delete
Object
list
Objects
copy
Object
presign
Object
@valon-technologies/gestalt
Loading...
Runtime hooks required to implement a Gestalt S3 provider.