package ansi

  1. Overview
  2. Docs
package ansi
Legend:
Library
Module
Module type
Parameter
Class
Class type

An ANSI escape sequence parser.

Parser

type t
val create : unit -> t

Create a new parser in the default state.

val process : t -> string -> string

process t data reads in data and generates HTML output, parsing escape sequences as it goes. If data ends with a partial sequence, it remembers this and will resume processing on the next call to process.

CSS Styling

The .fg-default and .bg-default CSS classes should be applied to the parent element of the processed strings.

val css : string

Some default CSS rules to make the HTML output appear in colour, using xterm defaults (light variant).

val css_dark : string

Some default CSS rules to make the HTML output appear in colour, using xterm defaults (dark variant).

val css_solarized : string

Some default CSS rules to make the HTML output appear in colour, with the Solarized colorscheme (light variant).

val css_solarized_dark : string

Some default CSS rules to make the HTML output appear in colour, with the Solarized colorscheme (dark variant).

Utils

val strip : string -> string

strip data reads in data and strips out ANSI sequences. It doesn't remember partial sequences between calls to strip.