@visulima/ansi/dist/notification.d.ts

ANSI escape codes for some terminal swag.

/**
 * Returns a sequence that triggers a desktop notification using the simple
 * `OSC 9` protocol popularised by iTerm2.
 *
 * Sequence: `OSC 9 ; Mc BEL`
 * @param message The notification body.
 * @returns The `OSC 9` escape sequence.
 * @example
 * ```typescript
 * import { notify } from "@visulima/ansi/notification";
 *
 * process.stdout.write(notify("Build finished"));
 * ```
 * @see {@link https://iterm2.com/documentation-escape-codes.html}
 */
declare const notify: (message: string) => string;
/**
 * Returns a sequence for the extensible `OSC 99` desktop notification protocol.
 *
 * `OSC 99` supports optional metadata (colon-separated `key=value` pairs, e.g.
 * `"i=1"`, `"d=1"`, `"p=title"`) followed by the payload body.
 *
 * Sequence: `OSC 99 ; metadata ; payload BEL`
 * @param payload The notification body.
 * @param metadata Optional metadata entries, joined with `:`.
 * @returns The `OSC 99` escape sequence.
 * @see {@link https://sw.kovidgoyal.net/kitty/desktop-notifications/}
 */
declare const desktopNotification: (payload: string, ...metadata: string[]) => string;
export { desktopNotification, notify };