Search documentation of Orchid

# Orchid.Plugin behaviour (Orchid v0.3.3)

View Source

Plugin behavior for extending Orchid's capabilities.

# Summary

## Callbacks

install(recipe, opts)

Receives the recipe and current runtime options, returns the modified versions.

# Callbacks

# install(recipe, opts)

    @callback install(recipe :: Orchid.Recipe.t(), opts :: keyword()) ::
      {:ok, {Orchid.Recipe.t(), opts :: keyword()}} | {:error, term()}

Receives the recipe and current runtime options, returns the modified versions.