Class APIFile

Represents a file sent directly to the API

Hierarchy

APIFile

Index

Constructors

constructor

Properties

name
path

Methods

read

Constructors

constructor

new APIFile(file: RequestFile): APIFile

- Defined in src/api/APIFile.ts:19
Parameters
- file: RequestFile
Returns APIFile

Properties

Readonly name

name: string

Readonly path

path: string

Methods

read

read(): Promise<ReadableStream>

- Defined in src/api/APIFile.ts:39
Reads the content of this file as a readable stream

Returns Promise<ReadableStream>

Generated using TypeDoc