Class: IQText
text.IQText
IQText class for advanced text manipulation
Table of contents
Constructors
Accessors
Methods
- append
- box
- center
- color
- left
- lower
- newlines
- pad
- prepend
- repeat
- reverse
- right
- set
- title
- toString
- truncate
- upper
- wrap
- center
- formatBytes
- formatDate
- formatDuration
- formatNumber
- left
- line
- progressBar
- right
- stripAnsi
- table
- truncate
- visibleLength
- wrap
Constructors
constructor
• new IQText(content?, width?)
Parameters
| Name | Type | Default value |
|---|---|---|
content |
string |
"" |
width |
number |
80 |
Defined in
Accessors
visibleLength
• get visibleLength(): number
Get visible length (excluding ANSI codes)
Returns
number
Defined in
Methods
append
▸ append(content): IQText
Append content
Parameters
| Name | Type |
|---|---|
content |
string |
Returns
Defined in
box
▸ box(options): IQText
Create a text box
Parameters
| Name | Type |
|---|---|
options |
ITextBoxOptions |
Returns
Defined in
center
▸ center(width?): IQText
Center text
Parameters
| Name | Type |
|---|---|
width? |
number |
Returns
Defined in
color
▸ color(color): IQText
Apply color
Parameters
| Name | Type |
|---|---|
color |
string |
Returns
Defined in
left
▸ left(width?): IQText
Left align text
Parameters
| Name | Type |
|---|---|
width? |
number |
Returns
Defined in
lower
▸ lower(): IQText
Convert to lowercase
Returns
Defined in
newlines
▸ newlines(count?, position?): IQText
Add newlines
Parameters
| Name | Type | Default value |
|---|---|---|
count |
number |
1 |
position |
"both" | "before" | "after" |
"after" |
Returns
Defined in
pad
▸ pad(length, char?, side?): IQText
Pad text
Parameters
| Name | Type | Default value |
|---|---|---|
length |
number |
undefined |
char |
string |
" " |
side |
"left" | "right" | "both" |
"right" |
Returns
Defined in
prepend
▸ prepend(content): IQText
Prepend content
Parameters
| Name | Type |
|---|---|
content |
string |
Returns
Defined in
repeat
▸ repeat(count): IQText
Repeat text
Parameters
| Name | Type |
|---|---|
count |
number |
Returns
Defined in
reverse
▸ reverse(): IQText
Reverse text
Returns
Defined in
right
▸ right(width?): IQText
Right align text
Parameters
| Name | Type |
|---|---|
width? |
number |
Returns
Defined in
set
▸ set(content): IQText
Set content
Parameters
| Name | Type |
|---|---|
content |
string |
Returns
Defined in
title
▸ title(): IQText
Title case
Returns
Defined in
toString
▸ toString(): string
Get the text content
Returns
string
Defined in
truncate
▸ truncate(maxLength, suffix?): IQText
Truncate text
Parameters
| Name | Type | Default value |
|---|---|---|
maxLength |
number |
undefined |
suffix |
string |
"..." |
Returns
Defined in
upper
▸ upper(): IQText
Convert to uppercase
Returns
Defined in
wrap
▸ wrap(options): IQText
Word wrap text
Parameters
| Name | Type |
|---|---|
options |
ITextWrapOptions |
Returns
Defined in
center
▸ Static center(text, width): string
Center text within width
Parameters
| Name | Type |
|---|---|
text |
string |
width |
number |
Returns
string
Defined in
formatBytes
▸ Static formatBytes(bytes, decimals?): string
Format bytes to human readable
Parameters
| Name | Type | Default value |
|---|---|---|
bytes |
number |
undefined |
decimals |
number |
2 |
Returns
string
Defined in
formatDate
▸ Static formatDate(date, format?): string
Format date
Parameters
| Name | Type | Default value |
|---|---|---|
date |
string | Date |
undefined |
format |
string |
"YYYY-MM-DD" |
Returns
string
Defined in
formatDuration
▸ Static formatDuration(seconds): string
Format duration to human readable
Parameters
| Name | Type |
|---|---|
seconds |
number |
Returns
string
Defined in
formatNumber
▸ Static formatNumber(num, separator?): string
Format number with thousands separator
Parameters
| Name | Type | Default value |
|---|---|---|
num |
number |
undefined |
separator |
string |
"," |
Returns
string
Defined in
left
▸ Static left(text, width): string
Left align text within width
Parameters
| Name | Type |
|---|---|
text |
string |
width |
number |
Returns
string
Defined in
line
▸ Static line(width, char?, color?): string
Create horizontal line
Parameters
| Name | Type | Default value |
|---|---|---|
width |
number |
undefined |
char |
string |
"─" |
color? |
string |
undefined |
Returns
string
Defined in
progressBar
▸ Static progressBar(current, total, width?, options?): string
Create a progress bar
Parameters
| Name | Type | Default value |
|---|---|---|
current |
number |
undefined |
total |
number |
undefined |
width |
number |
20 |
options? |
Object |
undefined |
options.empty? |
string |
undefined |
options.emptyColor? |
string |
undefined |
options.filled? |
string |
undefined |
options.filledColor? |
string |
undefined |
options.leftCap? |
string |
undefined |
options.rightCap? |
string |
undefined |
options.showPercent? |
boolean |
undefined |
Returns
string
Defined in
right
▸ Static right(text, width): string
Right align text within width
Parameters
| Name | Type |
|---|---|
text |
string |
width |
number |
Returns
string
Defined in
stripAnsi
▸ Static stripAnsi(text): string
Strip ANSI codes from text
Parameters
| Name | Type |
|---|---|
text |
string |
Returns
string
Defined in
table
▸ Static table(headers, rows, options?): string
Create a table
Parameters
| Name | Type |
|---|---|
headers |
string[] |
rows |
string[][] |
options? |
Object |
options.border? |
"ascii" | "none" | "single" | "double" |
options.cellPadding? |
number |
options.columnWidths? |
number[] |
options.headerColor? |
string |
Returns
string
Defined in
truncate
▸ Static truncate(text, maxLength, suffix?): string
Truncate text to max length
Parameters
| Name | Type | Default value |
|---|---|---|
text |
string |
undefined |
maxLength |
number |
undefined |
suffix |
string |
"..." |
Returns
string
Defined in
visibleLength
▸ Static visibleLength(text): number
Get visible length of text (excluding ANSI codes)
Parameters
| Name | Type |
|---|---|
text |
string |
Returns
number
Defined in
wrap
▸ Static wrap(text, width): string[]
Word wrap text to width
Parameters
| Name | Type |
|---|---|
text |
string |
width |
number |
Returns
string[]