Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileToUploadBase

A local file to upload.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private _NAME_AND_PATH

_NAME_AND_PATH: WithNameAndPath

Name and relative path information.

file

file: string

The path to the local file.

transformer

transformer: deploy_transformers.DataTransformer

The data transformer.

transformerOptions

transformerOptions: any

The options for the data transformer.

transformerStateKeyProvider

transformerStateKeyProvider: function

A function that provides a key for the state value of a data transformer.

Type declaration

    • (): any
    • Returns any

transformerSubContext

transformerSubContext: any

An sub context object for the transformer context.

workspace

workspace: Workspace

The underlying workspace.

Accessors

name

  • get name(): string

path

  • get path(): string

Methods

onBeforeUpload

  • onBeforeUpload(): Promise<void>
  • The method that should be invoked BEFORE an upload of that file starts.

    Returns Promise<void>

Protected Abstract onRead

  • onRead(): any
  • The logic for the 'read()' method.

    Returns any

    The promise with the read data.

onUploadCompleted

  • onUploadCompleted(): Promise<void>
  • The method that should be invoked AFTER an upload of that file has been finished.

    Returns Promise<void>

read

  • read(): Promise<any>
  • Reads the complete content of that file async.

    Returns Promise<any>

    The promise with the loaded data.

Generated using TypeDoc