Grains v1.7.1

Grains.Recipe (Grains v1.7.1)

A Recipe describes the data flow between the processes.

Link to this section Summary

Types

t()

Functions

merge(new_name, recipe1, recipe2)

Merges to recipes by combining all edges.

new(name, map)
to_mermaid(recipe, args \\ [])

Returns a mermaid flowchart as a string.

Link to this section Types

Link to this type

t()

Specs

t() :: %Grains.Recipe{map: map(), name: atom()}

Link to this section Functions

Link to this function

merge(new_name, recipe1, recipe2)

Merges to recipes by combining all edges.

Link to this function

new(name, map)

Link to this function

to_mermaid(recipe, args \\ [])

Returns a mermaid flowchart as a string.

Arguments

to_mermaid/2 supports an optional args argument. The following options are supported:

  • type: Graph type as string, can be either "flowchart" or "graph" (default: "graph")
  • direction: Flowchart orientation (default: "TD")
  • merge_edges: Merge multiple edges between a predecessor and a successor (default: false)