Class S3ProviderDriver

S3ProviderDriver is the driver for AWS S3 provider.

Hierarchy

S3ProviderDriver

Implements

ProviderDriver

Index

Constructors

Properties

Methods

createDir delete download exists read upload

Constructors

constructor

new S3ProviderDriver(options: {
    accessKeyId: string;
    endpoint: string;
    port: number;
    region: string;
    secretAccessKey: string;
    useSSL: boolean;
}): S3ProviderDriver
Parameters
- options: {
      accessKeyId: string;
      endpoint: string;
      port: number;
      region: string;
      secretAccessKey: string;
      useSSL: boolean;
  }
  - accessKeyId: string
  - endpoint: string
  - port: number
  - region: string
  - secretAccessKey: string
  - useSSL: boolean
Returns S3ProviderDriver
- Defined in providers/s3.ts:10

Properties

client

client: Client

region

region: string

Methods

createDir

createDir(name: string, mount: Mount): Promise<boolean>
Creates a directory

Returns
Returns true if the directory created, else false
Parameters
- name: string
  
  directory name
- mount: Mount
  
  mount to check
Returns Promise<boolean>
Implementation of ProviderDriver.createDir
- Defined in providers/s3.ts:47

delete

delete(filePath: string, mount: Mount): Promise<boolean>
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<boolean>
Implementation of ProviderDriver.delete
- Defined in providers/s3.ts:57

download

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

Returns
Parameters
- id: string
  
  id of the file
- mount: Mount
  
  mount to download the file from
- options: {} = {}
  
  options
Returns Promise<any>
Implementation of ProviderDriver.download
- Defined in providers/s3.ts:98

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/s3.ts:34

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/s3.ts:70

upload

upload(file: File, mount: Mount, options?: {}): Promise<any>
Upload a file
Parameters
- file: File
  
  file to upload
- mount: Mount
  
  mount to upload to
- options: {} = {}
  
  options
Returns Promise<any>
Implementation of ProviderDriver.upload
- Defined in providers/s3.ts:115

Generated using TypeDoc