tuil
ReferencePackages@mwillbanks/tuil-streamingAPI

StreamDecoder

interface exported by @mwillbanks/tuil-streaming.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-streaming.

export interface StreamDecoder {
  readonly id: string;
  write(chunk: Uint8Array | string): string;
  flush(): string;
  reset(): void;
}

Members

MemberTypeRequiredDescriptionRelated types
idstringYesThe id member uses the string contract.
write(chunk: Uint8Array | string) => stringYesThe write member uses the (chunk: Uint8Array | string) => string contract.
flush() => stringYesThe flush member uses the () => string contract.
reset() => voidYesThe reset member uses the () => void contract.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

No package-local related types.

Source

View the secondary source reference

Package

@mwillbanks/tuil-streaming

On this page