FSProvider Class

Hierarchy

FSProvider

Implements

Provider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FSProvider(options: FSProviderOptions): FSProvider

- Defined in provider-fs/src/FSProvider.ts:37
Parameters
- options: FSProviderOptions
Returns FSProvider

Properties

Readonly protocol

protocol: "file" = "file"

Readonly root

root: string

Methods

copyFile

copyFile(file: File, reason: Reason): Promise<ProviderOperation>

Implementation of Provider.copyFile
- Defined in provider-fs/src/FSProvider.ts:180
Parameters
- file: File
- reason: Reason
Returns Promise<ProviderOperation>

deleteFile

deleteFile(file: File): Promise<ProviderOperation>

Implementation of Provider.deleteFile
- Defined in provider-fs/src/FSProvider.ts:208
Parameters
- file: File
Returns Promise<ProviderOperation>

getFile

getFile(file: File): Promise<Readable>

Implementation of Provider.getFile
- Defined in provider-fs/src/FSProvider.ts:96
see

Readable

Parameters
- file: File
Returns Promise<Readable>

getFileCopySource

getFileCopySource(file: File): Promise<string>

Implementation of Provider.getFileCopySource
- Defined in provider-fs/src/FSProvider.ts:113
Parameters
- file: File
Returns Promise<string>

getFileETag

getFileETag(file: File): Promise<string>

Implementation of Provider.getFileETag
- Defined in provider-fs/src/FSProvider.ts:120
Parameters
- file: File
Returns Promise<string>

getTargetFileKey

getTargetFileKey(file: File): Promise<string>

Implementation of Provider.getTargetFileKey
- Defined in provider-fs/src/FSProvider.ts:139
Parameters
- file: File
Returns Promise<string>

listFiles

listFiles(onIgnore?: FileHandler): Promise<FileMap>

Implementation of Provider.listFiles
- Defined in provider-fs/src/FSProvider.ts:49
Parameters
- Optional onIgnore: FileHandler
Returns Promise<FileMap>

putFile

putFile(file: File, reason: Reason): Promise<ProviderOperation>

Implementation of Provider.putFile
- Defined in provider-fs/src/FSProvider.ts:148
Parameters
- file: File
- reason: Reason
Returns Promise<ProviderOperation>

Generated using TypeDoc