Interface PrintStringPositionOptions

interface PrintStringPositionOptions {
    caret?: string;
    maxColumns?: number;
    split?: number;
}

Properties

caret?: string

The caret indicator. The caret will be printed on a second row, directly underneath the column index represents. This may more than one character, where the first character will align with the index column. The default value is '^'.

maxColumns?: number

The maximum number of character columns to output. The number of columns shown will be the min of this value and the number of columns at the index row. The default is 60.

split?: number

A number between 0 and 1 representing the percentage of trailing to leading characters. 0 Indicates all trailing, 1 indicates all leading, and 0.5 indicates that the index column is as close to the middle as possible. The default value is 0.6.