Interface ActionStreamInput<S, O>

Interface for writing content to a stream.

interface ActionStreamInput<S, O> {
    done(output: O): Promise<void>;
    error(err: any): Promise<void>;
    write(chunk: S): Promise<void>;
}

Type Parameters

S
The type of the stream chunks.
O
The type of the final output.

Index

Methods

done error write

Methods

done

done(output: O): Promise<void>
Closes the stream with a final output.
Parameters
- output: O
  The final output data.
Returns Promise<void>
- Defined in core/lib/action-D-zq6SnX.d.ts:532

error

error(err: any): Promise<void>
Closes the stream with an error.
Parameters
- err: any
  The error that occurred.
Returns Promise<void>
- Defined in core/lib/action-D-zq6SnX.d.ts:537

write

write(chunk: S): Promise<void>
Writes a chunk to the stream.
Parameters
- chunk: S
  The chunk data to write.
Returns Promise<void>
- Defined in core/lib/action-D-zq6SnX.d.ts:527