Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DownloadedFile

A downloaded file.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new Disposable calling the provided function on dispose.

    Parameters

    • callOnDispose: Function

      Function that disposes something.

    Returns DownloadedFile

Properties

name

name: string

The name.

path

path: string

The path.

read

read: function

Reads the whole content of the file.

returns

The read data.

Type declaration

    • (): Buffer | PromiseLike<Buffer>

    • Returns Buffer | PromiseLike<Buffer>

Methods

dispose

  • dispose(): any

  • Dispose this object.

    Returns any

Static from

  • from(...disposableLikes: object[]): Disposable

  • Combine many disposable-likes into one. Use this method when having objects with a dispose function which are not instances of Disposable.

    Parameters

    • Rest ...disposableLikes: object[]

      Objects that have at least a dispose-function member.

    Returns Disposable

    Returns a new disposable which, upon dispose, will dispose all provided disposables.

Generated using TypeDoc