Class SimpleFileToDownload

A simple implementation of a file to download.

Hierarchy

SimpleFileToDownload

Implements

FileToDownload

Index

Constructors

constructor

Properties

Accessors

name
path

Methods

Constructors

constructor

new SimpleFileToDownload(workspace: Workspace, file: string, _NAME_AND_PATH: WithNameAndPath): SimpleFileToDownload

- Defined in plugins.ts:1184
Initializes a new instance of that class.

Parameters
- workspace: Workspace
  
  the underlying workspace.
- file: string
  
  The path to the (local) file.
- _NAME_AND_PATH: WithNameAndPath
  
  Name and relative path information.
Returns SimpleFileToDownload

Properties

Private _NAME_AND_PATH

_NAME_AND_PATH: WithNameAndPath

Name and relative path information.

file

file: string

The path to the (local) file.

workspace

workspace: Workspace

the underlying workspace.

Accessors

name

get name(): string

- Defined in plugins.ts:1198
The name.

inheritdoc

Returns string

path

get path(): string

- Defined in plugins.ts:1211
The path.

inheritdoc

Returns string

Methods

onBeforeDownload

onBeforeDownload(): Promise<void>

- Defined in plugins.ts:1203
The method that should be invoked BEFORE a download of that file starts.

Returns Promise<void>

onDownloadCompleted

onDownloadCompleted(): Promise<void>

- Defined in plugins.ts:1207
The method that should be invoked AFTER a download of that file has been finished.

Returns Promise<void>

Generated using TypeDoc