![\"yocto-spinner](\"media/logo.jpg\"){kind=logo}
\n\n\n\t
\n\t![](\"https://raw.githubusercontent.com/sindresorhus/ora/3c63d5e8569d94564b5280525350724817e9ac26/screenshot.svg\")
\n\t
\n
![](\"https://github.com/sindresorhus/ora/blob/main/screenshot-spinner.gif?raw=true\")
\n\nCustomize the spinner animation with a custom set of frames and interval.\n\n```js\n{\n\tframes: ['-', '\\\\', '|', '/'],\n\tinterval: 100,\n}\n```\n\nPass in any spinner from [`cli-spinners`](https://github.com/sindresorhus/cli-spinners).\n\n##### color\n\nType: `string`\\\nDefault: `'cyan'`\\\nValues: `'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'`\n\nThe color of the spinner.\n\n##### stream\n\nType: `stream.Writable`\\\nDefault: `process.stderr`\n\nThe stream to which the spinner is written.\n\n##### handleSignals\n\nType: `boolean`\\\nDefault: `true`\n\nWhether to register `SIGINT` and `SIGTERM` listeners that stop the spinner and explicitly exit the process.\n\nDisable this when the application needs to manage those signals itself.\n\n### Instance methods\n\n#### .start(text?)\n\nStarts the spinner.\n\nReturns the instance.\n\nOptionally, updates the text:\n\n```js\nspinner.start('Loading…');\n```\n\n#### .stop(finalText?)\n\nStops the spinner.\n\nReturns the instance.\n\nOptionally displays a final message.\n\n```js\nspinner.stop('Stopped.');\n```\n\n#### .success(text?)\n\nStops the spinner and displays a success symbol with the message.\n\nReturns the instance.\n\n```js\nspinner.success('Success!');\n```\n\n#### .error(text?)\n\nStops the spinner and displays an error symbol with the message.\n\nReturns the instance.\n\n```js\nspinner.error('Error!');\n```\n\n#### .warning(text?)\n\nStops the spinner and displays a warning symbol with the message.\n\nReturns the instance.\n\n```js\nspinner.warning('Warning!');\n```\n\n#### .clear()\n\nClears the spinner.\n\nReturns the instance.\n\n#### .info(text?)\n\nStops the spinner and displays an info symbol with the message.\n\nReturns the instance.\n\n```js\nspinner.info('Info.');\n```\n\n#### .text get/set\n\nChange the text displayed next to the spinner.\n\n```js\nspinner.text = 'New text';\n```\n\n#### .color get/set\n\nChange the spinner color.\n\n#### .isSpinning get\n\nReturns whether the spinner is currently spinning.\n\n## FAQ\n\n### How do I change the color of the text?\n\nUse [`yoctocolors`](https://github.com/sindresorhus/yoctocolors):\n\n```js\nimport yoctoSpinner from 'yocto-spinner';\nimport {red} from 'yoctocolors';\n\nconst spinner = yoctoSpinner({text: `Loading ${red('unicorns')}`}).start();\n```\n\n### Can I log messages while the spinner is running?\n\nYes. The spinner clears itself, writes your message, and re-renders below. This works with `console.log()` and `console.error()` while the spinner is running:\n\n```js\nconst spinner = yoctoSpinner({text: 'Processing…'}).start();\n\nconsole.log('Step 1 complete');\nconsole.error('Step 2 complete');\n\nspinner.success('Done!');\n```\n\n> [!NOTE]\n> Avoid running multiple spinners concurrently.\n\n### Why does the spinner freeze?\n\nJavaScript is single-threaded, so any synchronous operations will block the spinner's animation. To avoid this, prefer using asynchronous operations.\n\n## Comparison with [`ora`](https://github.com/sindresorhus/ora)\n\nOra offers more options, greater customizability, [promise handling](https://github.com/sindresorhus/ora?tab=readme-ov-file#orapromiseaction-options), and better Unicode detection. It’s a more mature and feature-rich package that handles more edge cases but comes with additional dependencies and a larger size. In contrast, this package is smaller, simpler, and optimized for minimal overhead, making it ideal for lightweight projects where dependency size is important. However, Ora is generally the better choice for most use cases.\n\n## Related\n\n- [ora](https://github.com/sindresorhus/ora) - Comprehensive terminal spinner\n- [yoctocolors](https://github.com/sindresorhus/yoctocolors) - Tiny terminal coloring\n- [nano-spawn](https://github.com/sindresorhus/nano-spawn) - Tiny process execution for humans\n","readmeFilename":"readme.md"}