API reference
linegauge/truncate
Every export of linegauge/truncate, with its signature and doc comment: truncate, plus 1 type.
import { truncate } from 'linegauge/truncate';Functions
truncate
function truncate(string: string, columns: number, options?: TruncateOptions): string;| Parameter | Type |
|---|---|
string | string |
columns | number |
options (optional) | TruncateOptions |
Returns string
Interfaces
TruncateOptions
interface TruncateOptions {
/** Which end loses characters. Default `'end'`. */
position?: 'start' | 'middle' | 'end';
/** The mark that says something was removed. Measured, not assumed. Default `'\u2026'`. */
ellipsis?: string;
}