Skip to content
ConsoleMonster

API Reference

Class

SpinnerHandle

Edit on GitHub
Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Source SpinnerHandle.cs:10
Base LiveHandle
Modifiers sealed

Thread-safe live handle for a Spinner.

Inheritance

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.

Returned or exposed by 1

Constructors

public SpinnerHandle(ILiveDispatcher dispatcher, String target) #
SpinnerHandle.cs:10

Creates a handle.

Parameters

dispatcher ConsoleMonster.Live.ILiveDispatcher requiredposition: 0
The dispatcher.
target System.String requiredposition: 1
The spinner name.

Methods

public Void Complete(StatusKind status = Pass, String? detail = null) #
SpinnerHandle.cs:28
Returns: Void

Sets the final status (Pass, Fail, Warn, Skip), optionally with a closing detail.

Parameters

status ConsoleMonster.Styling.StatusKind = Pass optionalposition: 0
The status.
detail System.String? = null optionalposition: 1
The detail, or null to keep the current one.
public Void Detail(String? detail) #
SpinnerHandle.cs:23
Returns: Void

Changes the muted detail, for example the current item.

Parameters

detail System.String? requiredposition: 0
The detail, or null to clear it.
public Void Label(String label) #
SpinnerHandle.cs:19
Returns: Void

Changes the label.

Parameters

label System.String requiredposition: 0
The label (markup).
public Void Start(String? label = null) #
SpinnerHandle.cs:15
Returns: Void

Restarts the clock and returns to running, optionally with a new label.

Parameters

label System.String? = null optionalposition: 0
The new label (markup), or null to keep it.