Class FairosProviderDriver

FairosProviderDriver is the driver for the FairOS provider.

Hierarchy

FairosProviderDriver

Implements

ProviderDriver

Index

Constructors

Properties

Methods

createDir delete download exists read upload

Constructors

constructor

new FairosProviderDriver(options: {
host: string;
}): FairosProviderDriver
Parameters
- options: {
  host: string;
  }
  - host: string
Returns FairosProviderDriver
- Defined in providers/fairos.ts:9

Properties

host

host: any

Methods

createDir

createDir(name: string, mount: Mount): Promise<any>
Parameters
- name: string
- mount: Mount
Returns Promise<any>
Implementation of ProviderDriver.createDir
- Defined in providers/fairos.ts:36

delete

delete(filePath: string, mount: Mount): Promise<any>
Delete a file or directory

Returns
Returns true if the file or directory was deleted, else false
Parameters
- filePath: string
  
  name of the file or directory
- mount: Mount
  
  mount point
Returns Promise<any>
Implementation of ProviderDriver.delete
- Defined in providers/fairos.ts:54

download

download(id: string, mount: Mount): Promise<any>
Download a file

Returns
Parameters
- id: string
  
  id of the file
- mount: Mount
  
  mount to download the file from
Returns Promise<any>
Implementation of ProviderDriver.download
- Defined in providers/fairos.ts:105

exists

exists(path: string, mount: Mount): Promise<boolean>
Verify if a file exists

Returns
Returns true if the file exists, else false
Parameters
- path: string
  
  path to the file
- mount: Mount
  
  mount to check
Returns Promise<boolean>
Implementation of ProviderDriver.exists
- Defined in providers/fairos.ts:18

read

read(mount: Mount): Promise<Entries>
Read entries from a mount point

Returns
Entries
Parameters
- mount: Mount
  
  mount point
Returns Promise<Entries>
Implementation of ProviderDriver.read
- Defined in providers/fairos.ts:72

upload

upload(file: File, mount: Mount, options?: {
overwrite: boolean;
path: string;
}): Promise<any>
Upload a file
Parameters
- file: File
  
  file to upload
- mount: Mount
  
  mount to upload to
- options: {
  overwrite: boolean;
  path: string;
  } = ...
  
  options
  - overwrite: boolean
  - path: string
Returns Promise<any>
Implementation of ProviderDriver.upload
- Defined in providers/fairos.ts:132

Generated using TypeDoc