API Reference
WatchOptions
Options for ConsoleWatch.Run.
Inheritance
- Object
- WatchOptions
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters 1
- Method ConsoleWatch.Run
Constructors
public WatchOptions() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public TimeSpan Interval { get; set; } #The time between the end of one run and the start of the next (default 2 seconds, at least 50 ms).
public Boolean Differences { get; set; } #Whether cells that changed since the previous run are highlighted.
public String? Title { get; set; } #What is being watched, shown in the heading (markup), or null.
public Boolean? Interactive { get; set; } #Whether to show a live view (true), print each run (false), or decide from the terminal (null, default): a live view only on an interactive terminal.
public LiveSessionOptions? Session { get; set; } #The live session's options for the interactive view (inline with the final frame kept, by default).
public Action<IWidget>? Print { get; set; } #Where a printed run goes when the view is not live, or null for the current terminal.
public Action<TimeSpan, CancellationToken>? Delay { get; set; } #Waits between runs (for tests), or null for a real wait that ends early on cancellation.
Fields
public static readonly TimeSpan MinimumInterval #The shortest interval (50 ms), so a watch never spins.