underlined
v1.0.4
Published
The module draws a string of characters of a certain length
Downloads
4
Readme
Underlined
The module draws a string of characters of a certain length
Make sure you use a monospaced font!
API
Underlined(input[, options])
input
Type: String
options
Type: Object
options.symbol
Type: String
Default: -
Underline character
options.with_string
Type: Boolean
Default: true
Do include input string into result
options.top
Type: Boolean
Default: false
Draw line at the top
options.bottom
Type: Boolean
Default: true
Draw line at the bottom
options.eol
Type: String
Default: \n
End of line character
Usage
Underlined('Lorem ipsum dolor sit amet, consectetur adipisicing elit');
Lorem ipsum dolor sit amet, consectetur adipisicing elit
--------------------------------------------------------
Underlined('Lorem ipsum dolor sit amet, consectetur adipisicing elit', { top: true });
--------------------------------------------------------
Lorem ipsum dolor sit amet, consectetur adipisicing elit
--------------------------------------------------------
Underlined('Lorem ipsum dolor sit amet, consectetur adipisicing elit', { symbol: '+', with_string: false });
++++++++++++++++++++++++++++++++++++++++++++++++++++++++