SpinnerOptions

The SpinnerOptions type defines the configuration options for a spinner component in ts-better-console. Spinners provide a visual loading indicator in the terminal and can be customized with different animation styles, custom frames, and intervals.

Type Definition

The SpinnerOptions type includes the following properties:

• style: An optional SpinnerStyle value that determines the animation style of the spinner. Available styles are "dots", "line", "bounce", "arrow", and "moon".
• frames: An optional array of strings that define custom animation frames for the spinner, overriding the default style.
• interval: An optional number (in milliseconds) that sets the speed of the spinner animation.

type SpinnerOptions = {
  style?: SpinnerStyle;
  frames?: string[];
  interval?: number;
}

Usage

You can pass SpinnerOptions when creating a spinner to customize its behavior:

import { Spinner } from "ts-better-console";

// Using a built-in style
new Spinner({
style: "dots",
interval: 80,
}).start();

// Using custom frames
new Spinner({
frames: ["🌑", "🌒", "🌓", "🌔", "🌕"],
interval: 150,
}).start();