# StreamEvent

Source: /tuil/docs/reference/packages/streaming/api/stream-event
Locale: en

type exported by @mwillbanks/tuil-streaming.



{/* Generated by tooling/docs/generate-reference.ts. */}

## type [#type]

Public type exported by `@mwillbanks/tuil-streaming`.

```ts
export type StreamEvent =
  | {
      readonly type: "document";
      readonly document: PartialDocument;
      readonly sequence: number;
    }
  | {
      readonly type: "diagnostic";
      readonly diagnostic: ParserDiagnostic;
      readonly sequence: number;
    }
  | { readonly type: "end"; readonly sequence: number };
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`ParserDiagnostic`](/tuil/docs/reference/packages/streaming/api/parser-diagnostic)
* [`PartialDocument`](/tuil/docs/reference/packages/streaming/api/partial-document)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/streaming/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-streaming](/tuil/docs/reference/packages/streaming)