À propos du projet
Ora est un paquet Node.js pour afficher un spinner animé dans les applications de terminal. Il peut être installé avec npm et importé en tant que module ES. L'export par défaut accepte du texte ou des options de configuration, y compris le texte de préfixe et de suffixe, le type de spinner, la couleur, la visibilité du curseur, l'indentation, l'intervalle d'animation, le flux de sortie, et l'activation ou la mise en silence forcée.
Ora fournit des méthodes d'instance pour changer le texte affiché et le style, vérifier s'il tourne, rendre manuellement des images, arrêter, effacer, et marquer le travail comme réussi, échoué, averti ou informatif. Il inclut également oraPromise pour associer un spinner à une promesse ou à une fonction retournant une promesse, avec des textes et symboles de succès et d'échec configurables.
Lorsqu'il est activé, Ora écrit dans un flux inscriptible configurable, normalement stderr. Il peut gérer les messages écrits dans ce flux pendant que le spinner est actif. La sortie du spinner n'est automatiquement activée que dans des environnements interactifs appropriés et désactivée dans des contextes comme CI, sauf configuration explicite. Le mode silencieux supprime toute sortie, tandis que le mode désactivé supprime le spinner et le style ANSI mais peut toujours afficher du texte.
Le paquet est destiné à un seul spinner à la fois. Il n'est pas conçu pour fonctionner dans les threads de travail Node.js car ils ne sont pas considérés comme des terminaux interactifs. Sur certains terminaux Windows, la prise en charge d'Unicode peut être indisponible ou difficile à détecter, donc le spinner en ligne ou un spinner explicitement sélectionné peut être nécessaire.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.