Documentation
Preparing search index...
@quatrain/storage
StorageAdapterInterface
Interface StorageAdapterInterface
These are the public functions that any storage adapter must expose
interface
StorageAdapterInterface
{
copy
(
file
:
FileType
,
destFile
:
FileType
)
:
Promise
<
any
>
;
create
(
file
:
FileType
,
stream
:
Readable
)
:
Promise
<
FileType
>
;
delete
(
file
:
FileType
)
:
Promise
<
Boolean
>
;
download
(
file
:
FileType
,
path
:
DownloadFileMetaType
)
:
Promise
<
string
>
;
generateImageThumbnail
(
file
:
FileType
,
sizes
:
number
[]
)
:
Promise
<
any
>
;
generateThumbnail
(
file
:
FileType
,
sizes
:
number
[]
)
:
Promise
<
any
>
;
generateVideoThumbnail
(
file
:
FileType
,
sizes
:
number
[]
)
:
Promise
<
any
>
;
getBucketStats
(
bucket
?:
string
,
prefix
?:
string
)
:
Promise
<
BucketStatsType
>
;
getDriver
()
:
any
;
getMetaData
(
filePath
:
FileType
)
:
Promise
<
FileType
>
;
getReadable
(
filePath
:
FileType
)
:
Promise
<
Readable
>
;
getUploadUrl
(
filePath
:
FileType
,
expiresIn
?:
number
)
:
Promise
<
any
>
;
getUrl
(
file
:
FileType
,
expiresIn
?:
number
,
action
?:
string
,
extra
?:
any
,
)
:
Promise
<
any
>
;
move
(
file
:
FileType
,
destFile
:
FileType
)
:
Promise
<
any
>
;
stream
(
file
:
FileType
,
res
:
any
)
:
Promise
<
any
>
;
}
Implemented by
AbstractStorageAdapter
Index
Methods
copy
create
delete
download
generate
Image
Thumbnail
generate
Thumbnail
generate
Video
Thumbnail
get
Bucket
Stats
get
Driver
get
Meta
Data
get
Readable
get
Upload
Url
get
Url
move
stream
Methods
copy
copy
(
file
:
FileType
,
destFile
:
FileType
)
:
Promise
<
any
>
Parameters
file
:
FileType
destFile
:
FileType
Returns
Promise
<
any
>
create
create
(
file
:
FileType
,
stream
:
Readable
)
:
Promise
<
FileType
>
Parameters
file
:
FileType
stream
:
Readable
Returns
Promise
<
FileType
>
delete
delete
(
file
:
FileType
)
:
Promise
<
Boolean
>
Parameters
file
:
FileType
Returns
Promise
<
Boolean
>
download
download
(
file
:
FileType
,
path
:
DownloadFileMetaType
)
:
Promise
<
string
>
Parameters
file
:
FileType
path
:
DownloadFileMetaType
Returns
Promise
<
string
>
generate
Image
Thumbnail
generateImageThumbnail
(
file
:
FileType
,
sizes
:
number
[]
)
:
Promise
<
any
>
Parameters
file
:
FileType
sizes
:
number
[]
Returns
Promise
<
any
>
generate
Thumbnail
generateThumbnail
(
file
:
FileType
,
sizes
:
number
[]
)
:
Promise
<
any
>
Parameters
file
:
FileType
sizes
:
number
[]
Returns
Promise
<
any
>
generate
Video
Thumbnail
generateVideoThumbnail
(
file
:
FileType
,
sizes
:
number
[]
)
:
Promise
<
any
>
Parameters
file
:
FileType
sizes
:
number
[]
Returns
Promise
<
any
>
get
Bucket
Stats
getBucketStats
(
bucket
?:
string
,
prefix
?:
string
)
:
Promise
<
BucketStatsType
>
Parameters
Optional
bucket
:
string
Optional
prefix
:
string
Returns
Promise
<
BucketStatsType
>
get
Driver
getDriver
()
:
any
Returns
any
get
Meta
Data
getMetaData
(
filePath
:
FileType
)
:
Promise
<
FileType
>
Parameters
filePath
:
FileType
Returns
Promise
<
FileType
>
get
Readable
getReadable
(
filePath
:
FileType
)
:
Promise
<
Readable
>
Parameters
filePath
:
FileType
Returns
Promise
<
Readable
>
get
Upload
Url
getUploadUrl
(
filePath
:
FileType
,
expiresIn
?:
number
)
:
Promise
<
any
>
Parameters
filePath
:
FileType
Optional
expiresIn
:
number
Returns
Promise
<
any
>
get
Url
getUrl
(
file
:
FileType
,
expiresIn
?:
number
,
action
?:
string
,
extra
?:
any
,
)
:
Promise
<
any
>
Parameters
file
:
FileType
Optional
expiresIn
:
number
Optional
action
:
string
Optional
extra
:
any
Returns
Promise
<
any
>
move
move
(
file
:
FileType
,
destFile
:
FileType
)
:
Promise
<
any
>
Parameters
file
:
FileType
destFile
:
FileType
Returns
Promise
<
any
>
stream
stream
(
file
:
FileType
,
res
:
any
)
:
Promise
<
any
>
Parameters
file
:
FileType
res
:
any
Returns
Promise
<
any
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
copy
create
delete
download
generate
Image
Thumbnail
generate
Thumbnail
generate
Video
Thumbnail
get
Bucket
Stats
get
Driver
get
Meta
Data
get
Readable
get
Upload
Url
get
Url
move
stream
Documentation
Loading...
These are the public functions that any storage adapter must expose