StreamRenderer
interface exported by @mwillbanks/tuil-streaming.
interface
Public interface exported by @mwillbanks/tuil-streaming.
export interface StreamRenderer<T = unknown> extends RenderProjection<T> {
render(projected: T): string | readonly string[];
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
render | (projected: T) => string | readonly string[] | Yes | The render member uses the (projected: T) => string | readonly string[] contract. | — |
id | string | Yes | The id member uses the string contract. | — |
project | (document: PartialDocument, context: { readonly signal: AbortSignal; }) => T | Promise<T> | Yes | The project member uses the (document: PartialDocument, context: { readonly signal: AbortSignal; }) => T | Promise<T> contract. | PartialDocument |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference