Catalyst.Plugin behaviour (Catalyst v1.0.0-beta.0)

Copy Markdown View Source

Summary

Callbacks

init(opts, config)

@callback init(opts :: keyword(), config :: map()) :: {:ok, keyword()} | {:error, term()}

opts_schema()

@callback opts_schema() :: keyword()

post_validate(execution, opts)

@callback post_validate(
  execution :: %Catalyst.Execution{
    action_executions: term(),
    config: term(),
    plugin_runs: term()
  },
  opts :: keyword()
) :: [Catalyst.ValidationAction.t()]

run(execution, opts)

@callback run(
  execution :: %Catalyst.Execution{
    action_executions: term(),
    config: term(),
    plugin_runs: term()
  },
  opts :: keyword()
) :: [Catalyst.Actions.t()]