Interface InputFile<TStream>

Universal interface exposed to tasks for streamed files.

interface InputFile<TStream = unknown> {
    extra?: Record<string, unknown>;
    lastModified?: number;
    name: string;
    size?: number;
    type?: string;
    resolve(): Promise<{ stream: TStream }>;
    stream(): TStream;
    toTempFile(dir?: string): Promise<{ bytesWritten: number; path: string }>;
}

Type Parameters

TStream = unknown

Hierarchy (View Summary)

InputFileMeta
- InputFile

Index

Properties

extra? lastModified? name size? type?

Methods

resolve stream toTempFile

Properties

`Optional`extra

extra?: Record<string, unknown>

`Optional`lastModified

lastModified?: number

name

name: string

`Optional`size

size?: number

`Optional`type

type?: string

Methods

resolve

resolve(): Promise<{ stream: TStream }>
Resolve the underlying stream for one-time consumption. Implementations must enforce single-use semantics.

Returns Promise<{ stream: TStream }>
- Defined in src/types/inputFile.ts:16

stream

stream(): TStream
Return the underlying stream (single-use). Should throw if already consumed.

Returns TStream
- Defined in src/types/inputFile.ts:21

toTempFile

toTempFile(dir?: string): Promise<{ bytesWritten: number; path: string }>
Persist the stream to a temporary file on disk and return its path and number of bytes written.
Parameters
- Optionaldir: string
Returns Promise<{ bytesWritten: number; path: string }>
- Defined in src/types/inputFile.ts:26