# FormatParserSession

Source: /tuil/docs/reference/packages/streaming/api/format-parser-session
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 FormatParserSession {
  write(chunk: string, complete: boolean): PartialDocument;
  reset(): void;
}
```

## Members [#members]

| Member  | Type                                                    | Required | Description                                                                                   | Related types                                                                |
| ------- | ------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `write` | `(chunk: string, complete: boolean) => PartialDocument` | Yes      | The `write` member uses the `(chunk: string, complete: boolean) => PartialDocument` contract. | [`PartialDocument`](/tuil/docs/reference/packages/streaming/api/partial-document) |
| `reset` | `() => void`                                            | Yes      | The `reset` member uses the `() => void` 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]

* [`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)