note

Preview

│
│ ──────────────────────────
│ Next Steps
│ Run the following command
│ to start:
│
│   npm run dev
│ ──────────────────────────

│
│ ──────────────────────────
│ All tests passed.
│ ──────────────────────────

Usage

import { note } from 'termprompt';

note('Run the following command to start:\n\n  npm run dev', 'Next Steps');

Parameters

With Title

note('DATABASE_URL=postgres://...\nREDIS_URL=redis://...', 'Environment Variables');

The title renders in bold using the success theme color, surrounded by horizontal rules.

Without Title

note('All tests passed.');

When no title is provided, the top rule renders in gray.