Módulo comunitario incrible

animación a tiza

Estado de compilación npm Codecov npm Estilo de código XO

Animacións coloridas na saída do terminal

Animacións dispoñibles

Nome Vista previa
arco da vella arco da vella
pulso pulso
fallo fallo
radar radar
neón neón
karaoke karaoke

Instalar

1
$ npm i chalk-animation

Uso

1 2 3
const chalkAnimation = require('chalk-animation'); chalkAnimation.rainbow('Lorem ipsum dolor sit amet');

Comezar e parar

Podes deter e retomar unha animación con stop()e start().

Cando se crea, a instancia de chalkAnimation comeza automaticamente .

1 2 3 4 5 6 7 8 9 10
const rainbow = chalkAnimation.rainbow('Lorem ipsum'); // Animation starts setTimeout(() => { rainbow.stop(); // Animation stops }, 1000); setTimeout(() => { rainbow.start(); // Animation resumes }, 2000);

Parada automática

Todo o que se imprima na consola deterá automaticamente a animación anterior

1 2 3 4 5
chalkAnimation.rainbow('Lorem ipsum'); setTimeout(() => { // Stop the 'Lorem ipsum' animation, then write on a new line. console.log('dolor sit amet'); }, 1000);

Cambio de velocidade

Cambia a velocidade da animación usando un segundo parámetro. Debe ser maior que 0, o predeterminado é 1.

1
chalkAnimation.rainbow('Lorem ipsum', 2); // Two times faster than default

Cambio de texto

Cambia o texto animado sen problemas con replace()

1 2 3 4 5 6 7
let str = 'Loading...'; const rainbow = chalkAnimation.rainbow(str); // Add a new dot every second setInterval(() => { rainbow.replace(str += '.'); }, 1000);

Representación manual

Representa manualmente os cadros con render()ou obtén o contido do seguinte cadro conframe()

1 2 3 4 5 6
const rainbow = chalkAnimation.rainbow('Lorem ipsum').stop(); // Don't start the animation rainbow.render(); // Display the first frame const frame = rainbow.frame(); // Get the second frame console.log(frame);

Modo CLI

1 2
# Install package globally $ npm install --global chalk-animation
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
$ chalk-animation --help Colorful animations in terminal output Usage $ chalk-animation <name> [options] [text...] Options --duration Duration of the animation in ms, defaults to Infinity --speed Animation speed as number > 0, defaults to 1 Available animations rainbow pulse glitch radar neon karaoke Example $ chalk-animation rainbow Hello world!

Licenza

MIT © Boris K