# `Six.Formatter`
[🔗](https://github.com/typicalpixel/six/blob/v0.1.0/lib/six/formatter.ex#L1)

Behaviour for Six coverage output formatters.

# `summary`

```elixir
@type summary() :: map()
```

# `format`

```elixir
@callback format(
  summary(),
  keyword()
) :: :ok | {:error, term()}
```

# `output_path`
*optional* 

```elixir
@callback output_path(keyword()) :: String.t() | nil
```

Optional callback for formatters that produce files.
Returns the path to the generated file.

---

*Consult [api-reference.md](api-reference.md) for complete listing*