# OperationProgress

Source: /tuil/docs/reference/packages/operations/api/operation-progress
Locale: en

interface exported by @mwillbanks/tuil-operations.



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

## interface [#interface]

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

```ts
export interface OperationProgress {
  readonly current: number;
  readonly total?: number;
  readonly message?: string;
}
```

## Members [#members]

| Member    | Type                  | Required | Description                                                   | Related types |
| --------- | --------------------- | -------- | ------------------------------------------------------------- | ------------- |
| `current` | `number`              | Yes      | The `current` member uses the `number` contract.              | —             |
| `total`   | `number \| undefined` | No       | The `total` member uses the `number \| undefined` contract.   | —             |
| `message` | `string \| undefined` | No       | The `message` member uses the `string \| undefined` 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]

No package-local related types.

## Source [#source]

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

## Package [#package]

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