@openinf/util-text
Essential cross-platform terminal-friendly text utilities
The high-level goal of @openinf/util-text
is to serve as a Node.js package
containing essential cross-platform text utilities that degrade gracefully
when used in terminals lacking feature support. As is the case with any software
project in continuous development, omissions and errors may exist, for which
contributions are welcome.
Installation
@openinf/util-text
runs on Node.js and is available via npm
.
npm install @openinf/util-text
Usage
To get started using the text utils provided by @openinf/util-text
, all
that needs to be done is either import/require (depending on the module format)
the default export of the module or destructure the individual named helper
functions exported.
import { blueify, ellipsify } from '@openinf/util-text';
console.log(blueify(ellipsify('Deserializing database tables')));
Functions
- blueify(text) ⇒
string
Returns the supplied string as blue colored if ANSI escapes are supported.
- curlyQuote(text) ⇒
string
Returns the supplied string as curly quoted if Unicode is supported.
- ellipsify(text) ⇒
string
Returns the supplied string as ellipsified if Unicode is supported.
- italicize(text) ⇒
string
Returns the supplied string as italicized if ANSI escapes are supported.
- mdCodeSpans2html(text) ⇒
string
Processes the supplied string by transforming any Markdown backtick code
spans (begining and ending with a single backtack) into HTML code elements.
- redden(text) ⇒
string
Returns the supplied string as red colored if ANSI escapes are supported.
- underline(text) ⇒
string
Returns the supplied string as underlined if ANSI escapes are supported.
- yellow(text) ⇒
string
Returns the supplied string as yellow colored if ANSI escapes are supported.
UnicodeEscapes : enum
Kind: global enum
Properties
Name | Type | Default |
---|
infoSymbol | string | "ⓘ" |
midlineEllipsis | string | "⋯" |
ellipsis | string | "…" |
errorSymbol | string | "ⓧ" |
leftDoubleQuotes | string | "“" |
rightDoubleQuotes | string | "”" |
warningSymbol | string | "⚠" |
blueify(text) ⇒ string
Returns the supplied string as blue colored if ANSI escapes are supported.
Kind: global function
curlyQuote(text) ⇒ string
Returns the supplied string as curly quoted if Unicode is supported.
Kind: global function
ellipsify(text) ⇒ string
Returns the supplied string as ellipsified if Unicode is supported.
Kind: global function
italicize(text) ⇒ string
Returns the supplied string as italicized if ANSI escapes are supported.
Kind: global function
mdCodeSpans2html(text) ⇒ string
Processes the supplied string by transforming any Markdown backtick code
spans (begining and ending with a single backtack) into HTML code elements.
Kind: global function
redden(text) ⇒ string
Returns the supplied string as red colored if ANSI escapes are supported.
Kind: global function
underline(text) ⇒ string
Returns the supplied string as underlined if ANSI escapes are supported.
Kind: global function
yellow(text) ⇒ string
Returns the supplied string as yellow colored if ANSI escapes are supported.
Kind: global function
© The OpenINF Authors