MarkdownPdfRunner Class

Summary

A wrapper around the markdown-pdf node module
Assembly
Cake.Markdown-Pdf.dll
Namespace
Cake.Markdown_Pdf
Interfaces
Base Types
graph BT Type-->Base0["Tool<MarkdownPdfRunnerSettings>"] Type-.->Interface0["IMarkdownPdfRunner"] click Interface0 "/api/Cake.Markdown_Pdf/IMarkdownPdfRunner" Type["MarkdownPdfRunner"] class Type type-node

Syntax

public class MarkdownPdfRunner : Tool<MarkdownPdfRunnerSettings>, IMarkdownPdfRunner

Constructors

Name Summary
MarkdownPdfRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Constructor for MarkdownPdfRunner

Methods

Name Value Summary
GetToolExecutableNames() IEnumerable<string>
Gets the name of the tool executables
GetToolName() string
Gets the name of the tool
Run(Action<MarkdownPdfRunnerSettings>) IMarkdownPdfRunner
Run markdown-pdf with configurator
Run(MarkdownPdfRunnerSettings) IMarkdownPdfRunner
Run markdown-pdf with settings

Extension Methods

Name Value Summary
Dump<MarkdownPdfRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<MarkdownPdfRunner>(MarkdownPdfRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MarkdownPdfRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<MarkdownPdfRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<MarkdownPdfRunner>(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
ThrowIfNull<MarkdownPdfRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin