-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
93c4f22
commit 61b0965
Showing
4 changed files
with
157 additions
and
105 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import * as ora from 'ora'; | ||
|
|
||
| /** | ||
| * A class that allows to delay the creation of a spinner, as well | ||
| * as schedule updates to the message of the spinner. Useful for | ||
| * scenarios where one wants to only show a spinner if an operation | ||
| * takes longer than a certain amount of time. | ||
| */ | ||
| export class DelayedSpinner { | ||
| spinner: ora.Ora; | ||
| timeouts: NodeJS.Timeout[] = []; | ||
| initial: number = Date.now(); | ||
|
|
||
| /** | ||
| * Constructs a new {@link DelayedSpinner} instance. | ||
| * | ||
| * @param message The message to display in the spinner | ||
| * @param ms The number of milliseconds to wait before creating the spinner | ||
| */ | ||
| constructor(message: string, ms: number = 500) { | ||
| this.timeouts.push( | ||
| setTimeout(() => { | ||
| this.spinner = ora(message); | ||
| }, ms).unref() | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the message to display in the spinner. | ||
| * | ||
| * @param message The message to display in the spinner | ||
| * @returns The {@link DelayedSpinner} instance | ||
| */ | ||
| setMessage(message: string) { | ||
| this.spinner.text = message; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Schedules an update to the message of the spinner. Useful for | ||
| * changing the message after a certain amount of time has passed. | ||
| * | ||
| * @param message The message to display in the spinner | ||
| * @param delay How long to wait before updating the message | ||
| * @returns The {@link DelayedSpinner} instance | ||
| */ | ||
| scheduleMessageUpdate(message: string, delay: number) { | ||
| this.timeouts.push( | ||
| setTimeout(() => { | ||
| this.spinner.text = message; | ||
| }, delay).unref() | ||
| ); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Stops the spinner and cleans up any scheduled timeouts. | ||
| */ | ||
| cleanup() { | ||
| this.spinner.stop(); | ||
| this.timeouts.forEach((t) => clearTimeout(t)); | ||
| } | ||
| } | ||
|
|
||
| export const SHOULD_SHOW_SPINNERS = process.stdout.isTTY; |