Skip to main content
Version: 3.0.0-beta

Interface: StorageSource

Properties​

deleteFile()​

deleteFile: (path, bucket?) => Promise<void>

Delete a file.

Parameters​

• path: string

• bucket?: string

Returns​

Promise<void>

Defined in​

packages/firecms_core/src/types/storage.ts:111


getDownloadURL()​

getDownloadURL: (pathOrUrl, bucket?) => Promise<DownloadConfig>

Convert a storage path or URL into a download configuration

Parameters​

• pathOrUrl: string

• bucket?: string

Returns​

Promise<DownloadConfig>

Defined in​

packages/firecms_core/src/types/storage.ts:96


getFile()​

getFile: (path, bucket?) => Promise<File>

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

Parameters​

• path: string

• bucket?: string

Returns​

Promise<File>

Defined in​

packages/firecms_core/src/types/storage.ts:104


list()​

list: (path, options?) => Promise<StorageListResult>

List the contents of a path.

Parameters​

• path: string

• options?

• options.bucket?: string

• options.maxResults?: number

• options.pageToken?: string

Returns​

Promise<StorageListResult>

Defined in​

packages/firecms_core/src/types/storage.ts:118


uploadFile()​

uploadFile: (__namedParameters) => Promise<UploadFileResult>

Upload a file, specifying a name and a path

Parameters​

• __namedParameters: UploadFileProps

Returns​

Promise<UploadFileResult>

Defined in​

packages/firecms_core/src/types/storage.ts:83

Sign up to our newsletter to get the latest news and updates. No spam!