# `PromptRunner.Rendering.Sink`
[🔗](https://github.com/nshkrdotcom/prompt_runner_sdk/blob/v0.6.1/lib/prompt_runner/rendering/sink.ex#L1)

Behaviour for output destinations that receive rendered prompt-runner text and raw events.

# `opts`

```elixir
@type opts() :: keyword()
```

# `state`

```elixir
@type state() :: term()
```

# `close`

```elixir
@callback close(state()) :: :ok
```

# `flush`

```elixir
@callback flush(state()) :: {:ok, state()}
```

# `init`

```elixir
@callback init(opts()) :: {:ok, state()} | {:error, term()}
```

# `write`

```elixir
@callback write(iodata(), state()) :: {:ok, state()} | {:error, term(), state()}
```

# `write_event`

```elixir
@callback write_event(event :: map(), iodata(), state()) ::
  {:ok, state()} | {:error, term(), state()}
```

---

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