DocumentTransformer
interface exported by @mwillbanks/tuil-streaming.
interface
Public interface exported by @mwillbanks/tuil-streaming.
export interface DocumentTransformer {
readonly id: string;
transform(
document: PartialDocument,
context: { readonly signal: AbortSignal },
): PartialDocument | Promise<PartialDocument>;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | Yes | The id member uses the string contract. | — |
transform | (document: PartialDocument, context: { readonly signal: AbortSignal; }) => PartialDocument | Promise<PartialDocument> | Yes | The transform member uses the (document: PartialDocument, context: { readonly signal: AbortSignal; }) => PartialDocument | Promise<PartialDocument> 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