# PartialDocument

Source: /tuil/docs/reference/packages/streaming/api/partial-document
Locale: en

interface exported by @mwillbanks/tuil-streaming.



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

## interface [#interface]

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

```ts
export interface PartialDocument {
  readonly format: string;
  readonly complete: boolean;
  readonly root: DocumentNode;
  readonly diagnostics: readonly ParserDiagnostic[];
  readonly source: string;
}
```

## Members [#members]

| Member        | Type                          | Required | Description                                                               | Related types                                                                  |
| ------------- | ----------------------------- | -------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| `format`      | `string`                      | Yes      | The `format` member uses the `string` contract.                           | —                                                                              |
| `complete`    | `boolean`                     | Yes      | The `complete` member uses the `boolean` contract.                        | —                                                                              |
| `root`        | `DocumentNode`                | Yes      | The `root` member uses the `DocumentNode` contract.                       | [`DocumentNode`](/tuil/docs/reference/packages/streaming/api/document-node)         |
| `diagnostics` | `readonly ParserDiagnostic[]` | Yes      | The `diagnostics` member uses the `readonly ParserDiagnostic[]` contract. | [`ParserDiagnostic`](/tuil/docs/reference/packages/streaming/api/parser-diagnostic) |
| `source`      | `string`                      | Yes      | The `source` member uses the `string` contract.                           | —                                                                              |

## 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]

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

## 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)