MermaidGraphGenerator Class

Summary

Generate graph outputs in mermaid syntax
Assembly
Cake.Graph.dll
Namespace
Cake.Graph.Generators
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["ITaskGraphGenerator"] click Interface0 "/api/Cake.Graph.Generators/ITaskGraphGenerator" Type["MermaidGraphGenerator"] class Type type-node

Syntax

public class MermaidGraphGenerator : ITaskGraphGenerator

Constructors

Properties

Name Value Summary
Extension string
Extension to use for the files by default

Methods

Name Value Summary
SerializeAsync(ICakeContext, ICakeTaskInfo, IReadOnlyList<ICakeTaskInfo>) Task<string>
Convert the task and dependencies to mermaid syntax string

Extension Methods

Name Value Summary
Dump<MermaidGraphGenerator>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<MermaidGraphGenerator>(MermaidGraphGenerator[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MermaidGraphGenerator>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<MermaidGraphGenerator>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<MermaidGraphGenerator>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MermaidGraphGenerator>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin