Simple terminal spinners for Deno 🦕
Version 0.4.1
Kia is based on, and has much of the features of, ora. The project was also influenced by the work of: cli-spinners, and CLI Spinners for Deno
import Kia from "https://deno.land/x/kia@0.4.1/mod.ts";
// Just a function to async sleep
function sleep(ms: number) {
return new Promise((resolve) => setTimeout(resolve, ms));
}
const kia: any = new Kia("I will be back in about 3 seconds");
kia.start();
await sleep(3000); // or any other async action that'll take some time
kia.succeed("Action completed");More thorough examples are available in the examples folder
Kia can be created with a string or the Options interface. A string is simply
mapped to Options.text
const kia = new Kia("Hello");
// or
const kia = new Kia({
text: "Hello",
color: "Red",
});You can pass any of the following options to the kia context:
Type: String
Default: ""
The text to display after the spinner
Type: Color
Default: "white"
The color for the spinner to be. Uses the color type in util.ts, which maps to the Deno standard colors.
Type: Spinner
Default: Dependent on OS (See below)
The spinner that the Kia instance should use. There are spinners provided in
spinners.ts or you can provide it with an object like so:
{
interval: 80,
frames: ["-", "|"]
}On windows the spinner defaults to windows, while on other OSes it defaults to
dots.
Spinners can also be imported from anywhere as long as they follow this format.
See the examples/externalSpinners.ts example for more info.
Type: number
Default: 0
The level of indentation of the spinner in spaces
Type: boolean
Default: false
Whether or not to display a cursor when the spinner is active
Type: Deno.Writer
Default: Deno.stdout
The resource to output to. This can be anything that uses the Writer interface including stdout, stderr, and files.
Starts the spinner. Optionally sets the text at the same time. Returns Kia instance.
Stops the spinner and clears the line. Returns Kia instance.
Allows you to change the spinners options. Returns Kia instance.
const kia = new Kia("Hello");
kia.set({ text: "Goodbye", color: "Red" });Stops the spinner, and returns a message with the current text or the provided
text as well as an icon indicating status. Wraps around stopWithFlair().
Returns Kia instance.
Stops the spinner, and returns a message with the current text or the provided
text as well as the preceding flair/icon. Returns Kia instance.
Stops the spinner and holds it in a static state. Returns the instance.
Renders the next frame of the spinner when it is stopped (i.e. can only be run after .stopAndPersist()).
Returns the current text of the spinner
Returns the current spinner frame
import { forPromise } from "https://deno.land/x/kia@0.4.1/mod.ts";
forPromise(
async () => {
await yourAsyncAction();
},
{ text: name },
);Starts a spinner for a promise. The spinner is stopped with .succeed() if the
promise fulfills or with .fail() if it rejects. Returns the spinner instance.
Type: Promise