Skip to main content

annotate

Callable

  • annotate(text: string, annotation: string): string

  • Can be used to wrap a piece of text with a visual annotation (iTerm only). If a terminal doe not support annotations, it will pass the text through.

    import { annotate } from '@boost/terminal';

    const text = annotate('fileName.js', absFilePath);