cli/utils/effectBoxen

Variables

effectBoxen

const effectBoxen: any;

Defined in: studiocms/packages/studiocms/src/cli/utils/effectBoxen.ts:42^

Creates a box in the terminal.

Param

The text inside the box.

Returns

The box.

Example

const message1 = yield* effectBoxen(
  (boxen) => boxen('unicorn', {padding: 1})
);

console.log(message1);
// ┌─────────────┐
// │             │
// │   unicorn   │
// │             │
// └─────────────┘

const message2 = yield* effectBoxen(
  (boxen) => boxen('unicorn', {
    padding: 1,
    margin: 1,
    borderStyle: 'double'
  })
);

console.log(message2);
//
// ╔═════════════╗
// ║             ║
// ║   unicorn   ║
// ║             ║
// ╚═════════════╝
//