Brunobkr/llama.cpp_AlgMor24_github

1type BoxBorderStyle = {2    /**3     * Top left corner4     * @example `┌`5     * @example `╔`6     * @example `╓`7     */8    tl: string;9    /**10     * Top right corner11     * @example `┐`12     * @example `╗`13     * @example `╖`14     */15    tr: string;16    /**17     * Bottom left corner18     * @example `└`19     * @example `╚`20     * @example `╙`21     */22    bl: string;23    /**24     * Bottom right corner25     * @example `┘`26     * @example `╝`27     * @example `╜`28     */29    br: string;30    /**31     * Horizontal line32     * @example `─`33     * @example `═`34     * @example `─`35     */36    h: string;37    /**38     * Vertical line39     * @example `│`40     * @example `║`41     * @example `║`42     */43    v: string;44};45declare const boxStylePresets: Record<string, BoxBorderStyle>;46type BoxStyle = {47    /**48     * The border color49     * @default 'white'50     */51    borderColor: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";52    /**53     * The border style54     * @default 'solid'55     * @example 'single-double-rounded'56     * @example57     * ```ts58     * {59     *   tl: '┌',60     *   tr: '┐',61     *   bl: '└',62     *   br: '┘',63     *   h: '─',64     *   v: '│',65     * }66     * ```67     */68    borderStyle: BoxBorderStyle | keyof typeof boxStylePresets;69    /**70     * The vertical alignment of the text71     * @default 'center'72     */73    valign: "top" | "center" | "bottom";74    /**75     * The padding of the box76     * @default 277     */78    padding: number;79    /**80     * The left margin of the box81     * @default 182     */83    marginLeft: number;84    /**85     * The top margin of the box86     * @default 187     */88    marginTop: number;89    /**90     * The top margin of the box91     * @default 192     */93    marginBottom: number;94};95/**96 * The border options of the box97 */98type BoxOpts = {99    /**100     * Title that will be displayed on top of the box101     * @example 'Hello World'102     * @example 'Hello {name}'103     */104    title?: string;105    style?: Partial<BoxStyle>;106};107/**108 * Creates a styled box with text content, customisable via options.109 * @param {string} text - The text to display in the box.110 * @param {BoxOpts} [_opts={}] - Optional settings for the appearance and behaviour of the box. See {@link BoxOpts}.111 * @returns {string} The formatted box as a string, ready for printing or logging.112 */113declare function box(text: string, _opts?: BoxOpts): string;114 115/**116 * Based on https://github.com/jorgebucaran/colorette117 * Read LICENSE file for more information118 * https://github.com/jorgebucaran/colorette/blob/20fc196d07d0f87c61e0256eadd7831c79b24108/index.js119 */120declare const colorDefs: {121    reset: (string: string) => string;122    bold: (string: string) => string;123    dim: (string: string) => string;124    italic: (string: string) => string;125    underline: (string: string) => string;126    inverse: (string: string) => string;127    hidden: (string: string) => string;128    strikethrough: (string: string) => string;129    black: (string: string) => string;130    red: (string: string) => string;131    green: (string: string) => string;132    yellow: (string: string) => string;133    blue: (string: string) => string;134    magenta: (string: string) => string;135    cyan: (string: string) => string;136    white: (string: string) => string;137    gray: (string: string) => string;138    bgBlack: (string: string) => string;139    bgRed: (string: string) => string;140    bgGreen: (string: string) => string;141    bgYellow: (string: string) => string;142    bgBlue: (string: string) => string;143    bgMagenta: (string: string) => string;144    bgCyan: (string: string) => string;145    bgWhite: (string: string) => string;146    blackBright: (string: string) => string;147    redBright: (string: string) => string;148    greenBright: (string: string) => string;149    yellowBright: (string: string) => string;150    blueBright: (string: string) => string;151    magentaBright: (string: string) => string;152    cyanBright: (string: string) => string;153    whiteBright: (string: string) => string;154    bgBlackBright: (string: string) => string;155    bgRedBright: (string: string) => string;156    bgGreenBright: (string: string) => string;157    bgYellowBright: (string: string) => string;158    bgBlueBright: (string: string) => string;159    bgMagentaBright: (string: string) => string;160    bgCyanBright: (string: string) => string;161    bgWhiteBright: (string: string) => string;162};163type ColorName = keyof typeof colorDefs;164type ColorFunction = (text: string | number) => string;165/**166 * An object containing functions for colouring text. Each function corresponds to a terminal colour. See {@link ColorName} for available colours.167 */168declare const colors: Record<ColorName, ColorFunction>;169/**170 * Gets a colour function by name, with an option for a fallback colour if the requested colour is not found.171 * @param {ColorName} color - The name of the colour function to get. See {@link ColorName}.172 * @param {ColorName} [fallback="reset"] - The name of the fallback colour function if the requested colour is not found. See {@link ColorName}.173 * @returns {ColorFunction} The colour function that corresponds to the requested colour, or the fallback colour function. See {@link ColorFunction}.174 */175declare function getColor(color: ColorName, fallback?: ColorName): ColorFunction;176/**177 * Applies a specified colour to a given text string or number.178 * @param {ColorName} color - The colour to apply. See {@link ColorName}.179 * @param {string | number} text - The text to colour.180 * @returns {string} The coloured text.181 */182declare function colorize(color: ColorName, text: string | number): string;183 184/**185 * Removes ANSI escape codes from a given string. This is particularly useful for186 * processing text that contains formatting codes, such as colours or styles, so that the187 * the raw text without any visual formatting.188 *189 * @param {string} text - The text string from which to strip the ANSI escape codes.190 * @returns {string} The text without ANSI escape codes.191 */192declare function stripAnsi(text: string): string;193/**194 * Centers a string within a specified total width, padding it with spaces or another specified character.195 * If the string is longer than the total width, it is returned as is.196 *197 * @param {string} str - The string to centre.198 * @param {number} len - The total width in which to centre the string.199 * @param {string} [space=" "] - The character to use for padding. Defaults to a space.200 * @returns {string} The centred string.201 */202declare function centerAlign(str: string, len: number, space?: string): string;203/**204 * Right-justifies a string within a given total width, padding it with whitespace or another specified character.205 * If the string is longer than the total width, it is returned as is.206 *207 * @param {string} str - The string to right-justify.208 * @param {number} len - The total width to align the string.209 * @param {string} [space=" "] - The character to use for padding. Defaults to a space.210 * @returns {string} The right-justified string.211 */212declare function rightAlign(str: string, len: number, space?: string): string;213/**214 * Left-aligns a string within a given total width, padding it with whitespace or another specified character on the right.215 * If the string is longer than the total width, it is returned as is.216 *217 * @param {string} str - The string to align left.218 * @param {number} len - The total width to align the string.219 * @param {string} [space=" "] - The character to use for padding. Defaults to a space.220 * @returns {string} The left-justified string.221 */222declare function leftAlign(str: string, len: number, space?: string): string;223/**224 * Aligns a string (left, right, or centre) within a given total width, padding it with spaces or another specified character.225 * If the string is longer than the total width, it is returned as is. This function acts as a wrapper for individual alignment functions.226 *227 * @param {"left" | "right" | "centre"} alignment - The desired alignment of the string.228 * @param {string} str - The string to align.229 * @param {number} len - The total width in which to align the string.230 * @param {string} [space=" "] - The character to use for padding. Defaults to a space.231 * @returns {string} The aligned string, according to the given alignment.232 */233declare function align(alignment: "left" | "right" | "center", str: string, len: number, space?: string): string;234 235type TreeItemObject = {236    /**237     * Text of the item238     */239    text: string;240    /**241     * Children of the item242     */243    children?: TreeItem[];244    /**245     * Color of the item246     */247    color?: ColorName;248};249type TreeItem = string | TreeItemObject;250type TreeOptions = {251    /**252     * Color of the tree253     */254    color?: ColorName;255    /**256     * Prefix of the tree257     *258     * @default "  "259     */260    prefix?: string;261    /**262     * The max depth of tree263     */264    maxDepth?: number;265    /**266     * Ellipsis of the tree267     *268     * @default "..."269     */270    ellipsis?: string;271};272/**273 * Formats a hierarchical list of items into a string representing a tree structure.274 * Each item in the tree can be a simple string or an object defining the text of the item,275 * optional children, and colour. The tree structure can be customised with options276 * Specify the overall colour and the prefix used for indentation and tree lines.277 *278 * @param {TreeItem[]} items - An array of items to include in the tree. Each item can be279 * either a string or an object with `text', `children' and `colour' properties.280 * @param {TreeOptions} [options] - Optional settings to customise the appearance of the tree, including281 * the colour of the tree text and the prefix for branches. See {@link TreeOptions}.282 * @returns {string} The formatted tree as a string, ready for printing to the console or elsewhere.283 */284declare function formatTree(items: TreeItem[], options?: TreeOptions): string;285 286export { type BoxBorderStyle, type BoxOpts, type BoxStyle, type ColorFunction, type ColorName, type TreeItem, type TreeItemObject, type TreeOptions, align, box, centerAlign, colorize, colors, formatTree, getColor, leftAlign, rightAlign, stripAnsi };287