Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@atlassian/terminal-dispatch-state

0.0.2 • Public • Published

terminal-dispatch-state

Build dynamic terminal interfaces by updating the state.

API

import { Store } from '@atlassian/terminal-dispatch-state';
import ora from 'ora'; // if you want to show a spinner
 
const store = new Store();
const state = [
  'line1',
  'line2',
  'line3',
];
 
store.update(state); // renders three lines in the terminal
 
state.push('line4');
store.update(state); // does not render anything because state is the same object
 
const newState = [...state];
store.update(newState); // adds one line
 
const spinner = ora('Loading unicorns');
const newStateWithUnicorns = [
  ...newState,
  { spinner, isRunning: true }
]
store.update([...newState, progress]); // adds ora spinner with text
 
store.stop();

Install

npm i @atlassian/terminal-dispatch-state

DownloadsWeekly Downloads

3

Version

0.0.2

License

MIT

Unpacked Size

12.4 kB

Total Files

6

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar