cspell/dist/esm/util/pad.d.ts

A Spelling Checker for Code!

export declare function pad(s: string, w: number): string;
export declare function padWidth(s: string, target: number): number;
export declare function padLeft(s: string, w: number): string;
export declare function width(s: string): number;
export declare function ansiWidth(s: string): number;
/**
 * Prune the end of a string to fit within a specified width, adding an ellipsis if necessary.
 * @param str - the text to prune - ANSI is not supported
 * @param maxWidth - the maximum width of the text
 * @param pad - the string to use for padding, default is '…'
 * @returns the pruned text
 */
export declare function pruneTextEnd(str: string, maxWidth: number | undefined, pad?: string): string;
/**
 * Prune the start of a string to fit within a specified width, adding an ellipsis if necessary.
 * @param str - the text to prune - ANSI is not supported
 * @param maxWidth - the maximum width of the text
 * @param pad - the string to use for padding, default is '…'
 * @returns the pruned text
 */
export declare function pruneTextStart(str: string, maxWidth: number | undefined, pad?: string): string;
//# sourceMappingURL=pad.d.ts.map