Skip to content

docs: document color methods #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 1 commit into from
Jul 20, 2026
Merged

docs: document color methods #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,9 @@ logger.info('server started');

You can import `color` directly from `rslog` to style your own output:

It is a small wrapper around Node.js `styleText`, with a simpler API for common styling.
It is a small wrapper around Node.js
[`styleText`](https://nodejs.org/api/util.html#utilstyletextformat-text-options),
with a simpler API for common styling.

```js
import { color, logger } from 'rslog';
Expand All @@ -196,6 +198,26 @@ logger.info(color.bold(color.blue('build complete')));
logger.error(color.red('something went wrong'));
```

Each method accepts a `string` or `number` and returns a styled string. You can
combine multiple styles by nesting method calls.

| Method | Effect |
| --------------------------- | ------------------------------ |
| `color.bold(text)` | Makes the text bold |
| `color.dim(text)` | Makes the text dim |
| `color.underline(text)` | Underlines the text |
| `color.strikethrough(text)` | Adds a strikethrough |
| `color.black(text)` | Colors the text black |
| `color.red(text)` | Colors the text red |
| `color.green(text)` | Colors the text green |
| `color.yellow(text)` | Colors the text yellow |
| `color.blue(text)` | Colors the text blue |
| `color.magenta(text)` | Colors the text magenta |
| `color.cyan(text)` | Colors the text cyan |
| `color.white(text)` | Colors the text white |
| `color.gray(text)` | Colors the text gray |
| `color.reset(text)` | Resets all styles for the text |

## Environment

Rslog supports Node.js `^20.19.0 || >=22.12.0`.
Expand Down