Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileToUpload

A file to upload.

Hierarchy

Implemented by

Index

Properties

Properties

file

file: string

The path to the (local) file.

name

name: string

The name.

onBeforeUpload

onBeforeUpload: BeforeUploadFileCallback

The method that should be invoked BEFORE an upload of that file starts.

param

A custom value for the destination.

onUploadCompleted

onUploadCompleted: UploadFileCompletedCallback

The method that should be invoked AFTER an upload of that file has been finished.

param

The error (if occurred).

path

path: string

The path.

read

read: function

Reads the complete content of that file async.

returns

The promise with the loaded data.

Type declaration

    • (): PromiseLike<Buffer>

    • Returns PromiseLike<Buffer>

workspace

workspace: Workspace

The underlying workspace.

Generated using TypeDoc