# useTerminalFormSnapshot

Source: /tuil/docs/reference/packages/form/api/use-terminal-form-snapshot
Locale: en

function exported by @mwillbanks/tuil-form.



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

## function [#function]

Public function exported by `@mwillbanks/tuil-form`.

```ts
export function useTerminalFormSnapshot(): {
  readonly dirty: boolean;
  readonly errors: readonly FormValidationError[];
  readonly values: Readonly<Record<string, unknown>>;
};
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

`{
  readonly dirty: boolean;
  readonly errors: readonly FormValidationError[];
  readonly values: Readonly<Record<string, unknown>>;
}` — Returns a value that satisfies `{
  readonly dirty: boolean;
  readonly errors: readonly FormValidationError[];
  readonly values: Readonly<Record<string, unknown>>;
}`.

Related types: [`FormValidationError`](/tuil/docs/reference/packages/form/api/form-validation-error)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`FormValidationError`](/tuil/docs/reference/packages/form/api/form-validation-error)

## Source [#source]

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

## Package [#package]

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