<!-- Public documentation export; not library implementation source. -->
# IFormatter

[Integration guide](https://docs.lumencharts.com/charting-library/reference/compatibility) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

## format {#format}

```ts
format(value?: T): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `T` | No |

## parse {#parse}

```ts
parse?(
    value: string,
  ): ErrorFormatterParseResult | SuccessFormatterParseResult<T>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## Related types

- [ErrorFormatterParseResult](https://docs.lumencharts.com/charting-library/api/ErrorFormatterParseResult)
- [SuccessFormatterParseResult](https://docs.lumencharts.com/charting-library/api/SuccessFormatterParseResult)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IFormatter