Sake.Progress (Sake v0.4.3)

Copy Markdown View Source

Progress and log notifications from inside a component.

Sake.Progress.report(ctx, 3, 10)
Sake.Progress.report(ctx, 3, 10, "Indexing")
Sake.Progress.log(ctx, :info, %{"step" => "index"})

Progress goes out only when the request carried a progress token; log messages only when the request set a log level at or below level.

Summary

Functions

log(arg1, level, data)

@spec log(Sake.Context.t(), atom(), term()) :: :ok

report(context, current, total \\ nil, message \\ nil)

@spec report(Sake.Context.t(), number(), number() | nil, String.t() | nil) :: :ok