Cmdlet

New-ConsoleSpinner

Module ConsoleMonster

Inputs

None

Outputs

ConsoleMonster.Widgets.Spinner

Creates a spinner: a one-line activity indicator for work without a known total.

Syntax

New-ConsoleSpinner [-Detail <Object>] [[-Label] <Object>] [-Name <String>] [-NoElapsed] [-Status <StatusKind>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Creates a spinner: a one-line activity indicator for work without a known total.

While running it animates (braille on modern fonts, | / - \ on Basic and ASCII) and shows the label, a muted detail and the elapsed time. Once finished it shows the status marker in the status colour and the final duration. Update it live with Update-ConsoleSpinner.

Examples

Authored help example

EXAMPLE 1

New-ConsoleSpinner -Name 'Name'

Parameters

-Detail Object optional: Muted detail after the label, for example the current item.
-Label Object optionalposition: 0: The label (markup allowed).
-Name String optional: The live name (default spinner).
-NoElapsed SwitchParameter optional: Hide the elapsed time.
-Status StatusKind optional: The initial status (default Running).; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.