Interface ProviderDriver

ProviderDriver is the interface that all providers must implement that adheres for W3C FileSystem API.

Hierarchy

  • ProviderDriver

Implemented by

Properties

createDir delete download exists read upload

Properties

createDir

createDir: ((name: string, mount: Mount) => Promise<boolean>)

Type declaration

    • (name: string, mount: Mount): Promise<boolean>

    • Parameters

      • name: string
      • mount: Mount

      Returns Promise<boolean>

delete

delete: ((name: string, mount: Mount) => Promise<boolean>)

Type declaration

    • (name: string, mount: Mount): Promise<boolean>

    • Delete a file or directory

      Returns

      Returns true if the file or directory was deleted, else false

      Parameters

      • name: string

        name of the file or directory

      • mount: Mount

        mount point

      Returns Promise<boolean>

download

download: ((name: string, mount: Mount, options: any) => Promise<any>)

Type declaration

    • (name: string, mount: Mount, options: any): Promise<any>

    • Download entries from a mount point

      Returns

      Result

      Parameters

      • name: string

        name of the file

      • mount: Mount

        mount point

      • options: any

        options

      Returns Promise<any>

exists

exists: ((name: string, mount: Mount) => Promise<boolean>)

Type declaration

    • (name: string, mount: Mount): Promise<boolean>

    • Reuturns true if the file or directory exists

      Returns

      A boolean value indicating whether the file or directory exists

      Parameters

      • name: string

        The name of the file or directory

      • mount: Mount

        mount point

      Returns Promise<boolean>

read

read: ((mount: Mount) => Promise<Entries>)

Type declaration

    • (mount: Mount): Promise<Entries>

    • Read entries from a mount point

      Returns

      Entries

      Parameters

      • mount: Mount

        mount point

      Returns Promise<Entries>

upload

upload: ((file: File, mount: Mount, options: any) => Promise<any>)

Type declaration

    • (file: File, mount: Mount, options: any): Promise<any>

    • Upload entries from a file

      Returns

      Result

      Parameters

      • file: File

        file to upload

      • mount: Mount

        mount point

      • options: any

        options

      Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc