FSProviderBridge Interface

Hierarchy

FSProviderBridge

Implemented by

FSBridge

Index

Methods

Methods

copyObject

copyObject(params: FSCopyParams): Promise<void>

- Defined in provider-fs/src/types/FSProviderBridge.ts:8
Copy local file to destination path

Parameters
- params: FSCopyParams
Returns Promise<void>

deleteObject

deleteObject(params: FSDeleteParams): Promise<void>

- Defined in provider-fs/src/types/FSProviderBridge.ts:13
Permanently delete local file

Parameters
- params: FSDeleteParams
Returns Promise<void>

getMD5FromReadStream

getMD5FromReadStream(stream: Readable): Promise<string | null>

- Defined in provider-fs/src/types/FSProviderBridge.ts:26
Get MD5 hash from Readable stream

see

{@linkcode md5FromStream}

see

Readable

Parameters
- stream: Readable
Returns Promise<string | null>

getObjectReadStream

getObjectReadStream(params: FSGetParams): Readable

- Defined in provider-fs/src/types/FSProviderBridge.ts:19
Get readable stream for a local file

see

Readable

Parameters
- params: FSGetParams
Returns Readable

listObjects

listObjects(filePath: string): Promise<string[]>

- Defined in provider-fs/src/types/FSProviderBridge.ts:31
Non-recursively list files in directory and return found paths as an array of strings

Parameters
- filePath: string
Returns Promise<string[]>

objectExists

objectExists(filePath: string): Promise<boolean>

- Defined in provider-fs/src/types/FSProviderBridge.ts:36
Parameters
- filePath: string
Returns Promise<boolean>

true if file/directory exists at path, otherwise false

objectStats

objectStats(filePath: string): Promise<Stats>

- Defined in provider-fs/src/types/FSProviderBridge.ts:41
Get file status

Parameters
- filePath: string
Returns Promise<Stats>

putObject

putObject(params: FSPutParams): Promise<void>

- Defined in provider-fs/src/types/FSProviderBridge.ts:46
Write content to output stream

Parameters
- params: FSPutParams
Returns Promise<void>

Generated using TypeDoc