Skip to main content
Version: 2.0.0

Interface: StorageSource

Properties​

getDownloadURL​

• getDownloadURL: (pathOrUrl: string) => Promise<DownloadConfig>

Type declaration​

â–¸ (pathOrUrl): Promise<DownloadConfig>

Convert a storage path or URL into a download configuration

Parameters​
NameType
pathOrUrlstring
Returns​

Promise<DownloadConfig>

Defined in​

packages/firecms/src/types/storage.ts:86


getFile​

• getFile: (path: string) => Promise<null | File>

Type declaration​

â–¸ (path): Promise<null | File>

Get a file from a storage path. It returns null if the file does not exist.

Parameters​
NameType
pathstring
Returns​

Promise<null | File>

Defined in​

packages/firecms/src/types/storage.ts:93


uploadFile​

• uploadFile: (__namedParameters: UploadFileProps) => Promise<UploadFileResult>

Type declaration​

▸ («destructured»): Promise<UploadFileResult>

Upload a file, specifying a name and a path

Parameters​
NameType
«destructured»UploadFileProps
Returns​

Promise<UploadFileResult>

Defined in​

packages/firecms/src/types/storage.ts:75

Enterprise or start-up?

Learn how to get the most out of your project with the help of our consulting team.
Learn more
Sign up to our newsletter to get the latest news and updates. No spam!