tuil
ReferencePackages@mwillbanks/tuil-streamingAPI

StreamRenderer

interface exported by @mwillbanks/tuil-streaming.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-streaming.

export interface StreamRenderer<T = unknown> extends RenderProjection<T> {
  render(projected: T): string | readonly string[];
}

Members

MemberTypeRequiredDescriptionRelated types
render(projected: T) => string | readonly string[]YesThe render member uses the (projected: T) => string | readonly string[] contract.
idstringYesThe id member uses the string contract.
project(document: PartialDocument, context: &#123; readonly signal: AbortSignal; &#125;) => T | Promise<T>YesThe project member uses the (document: PartialDocument, context: &#123; readonly signal: AbortSignal; &#125;) => 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.

Source

View the secondary source reference

Package

@mwillbanks/tuil-streaming

On this page