ASM.Extensions.Rendering (ASM v0.9.2)

Copy Markdown View Source

Public rendering extension API.

This domain consumes %ASM.Event{} streams and dispatches renderer output to one or more sinks, keeping output concerns outside the run loop.

Summary

Types

renderer_spec()

@type renderer_spec() :: {module(), keyword()}

sink_spec()

@type sink_spec() :: {module(), keyword()}

Functions

callback_sink(opts \\ [])

@spec callback_sink(keyword()) :: sink_spec()

compact_renderer(opts \\ [])

@spec compact_renderer(keyword()) :: renderer_spec()

file_sink(opts)

@spec file_sink(keyword()) :: sink_spec()

jsonl_sink(opts)

@spec jsonl_sink(keyword()) :: sink_spec()

stream(event_stream, opts \\ [])

@spec stream(
  Enumerable.t(),
  keyword()
) :: :ok | {:error, ASM.Error.t()}

tty_sink(opts \\ [])

@spec tty_sink(keyword()) :: sink_spec()

verbose_renderer(opts \\ [])

@spec verbose_renderer(keyword()) :: renderer_spec()