Skip to content
ConsoleMonster
Class

RunOptionsFluent

ConsoleMonster.Live

Namespace
ConsoleMonster.Live
Assembly
ConsoleMonster
Modifiers
static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of RunOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • RunOptionsFluent

Methods

public static RunOptions Configure(RunOptions runOptions, Action<RunOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

runOptions ConsoleMonster.Live.RunOptions required
The instance.
configure System.Action<ConsoleMonster.Live.RunOptions> required
Assignments applied in order.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunOptions { Label = value };    Ui.Options<global::ConsoleMonster.Live.RunOptions>().Configure(configured => configured.Label = value);
// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunOptions { Print = value };    Ui.Options<global::ConsoleMonster.Live.RunOptions>().Configure(configured => configured.Print = value);
public static RunOptions Live(RunOptions runOptions, bool? value) #

Sets RunOptions.Live: Whether to show the live view (true), print a line per item (false) or decide from the terminal (null, default).

Parameters

runOptions ConsoleMonster.Live.RunOptions required
The instance.
value bool? required
The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                   // C# fluent
new global::ConsoleMonster.Live.RunOptions { Live = value };    Ui.Options<global::ConsoleMonster.Live.RunOptions>().Live(value);
Session 2 overloads
public static RunOptions Session(RunOptions runOptions, LiveSessionOptions? value) #

Sets RunOptions.Session: The live session's options (inline with the final frame kept, by default).

Parameters

runOptions ConsoleMonster.Live.RunOptions required
The instance.
value ConsoleMonster.Live.LiveSessionOptions? required
The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.RunOptions { Session = value };    Ui.Options<global::ConsoleMonster.Live.RunOptions>().Session(value);
public static RunOptions Session(RunOptions runOptions, Action<LiveSessionOptions> configure) #

Configures RunOptions.Session in place (creating it when not set): The live session's options (inline with the final frame kept, by default).

Parameters

runOptions ConsoleMonster.Live.RunOptions required
The instance.
configure System.Action<ConsoleMonster.Live.LiveSessionOptions> required
Configures the value.

Returns

RunOptions The same instance.
public static RunOptions ThrottleLimit(RunOptions runOptions, int value) #

Sets RunOptions.ThrottleLimit: How many items run at the same time (default the processor count).

Parameters

runOptions ConsoleMonster.Live.RunOptions required
The instance.
value int required
The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Live.RunOptions { ThrottleLimit = value };    Ui.Options<global::ConsoleMonster.Live.RunOptions>().ThrottleLimit(value);
public static RunOptions Timeout(RunOptions runOptions, TimeSpan? value) #

Sets RunOptions.Timeout: The time one item may take, or null for no limit; an item past it is cancelled and counts as failed.

Parameters

runOptions ConsoleMonster.Live.RunOptions required
The instance.
value System.TimeSpan? required
The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.RunOptions { Timeout = value };    Ui.Options<global::ConsoleMonster.Live.RunOptions>().Timeout(value);
public static RunOptions Title(RunOptions runOptions, string? value) #

Sets RunOptions.Title: A title above the live view (markup), or null.

Parameters

runOptions ConsoleMonster.Live.RunOptions required
The instance.
value string? required
The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunOptions { Title = value };    Ui.Options<global::ConsoleMonster.Live.RunOptions>().Title(value);