# SyGridWorkbookFlushReport

Fields, allowed values, and APIs that use SyGridWorkbookFlushReport.

Canonical: https://grid.syidax.com/docs/types/SyGridWorkbookFlushReport/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface SyGridWorkbookFlushReport {
  status: 'flushed' | 'empty' | 'inactive';
  reason: SyGridWorkbookInactiveReason | null;
  transactionCount: number;
  generations: ReadonlyArray<number>;
  issue: string;
}
```

<a id="used-by"></a>

## APIs using this type

- [flushWorkbookPropagation](https://grid.syidax.com/docs/methods/flushWorkbookPropagation.md) — Processes pending workbook value propagation and returns the result.

<a id="parents"></a>

## Contracts containing this type

- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)

<a id="related"></a>

## Related types

- [SyGridWorkbookInactiveReason](https://grid.syidax.com/docs/types/SyGridWorkbookInactiveReason.md)