Skip to content package
colors-option v4.5.0 Let users toggle colors
node >=14.18.0 2 deps esm types open source
overview readme
license MIT
deps 2
unpacked 9.4 kB
files 6
node >=14.18.0 $ npm install colors-option@4.5.0n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
color colors option config configuration disable chalk typescript ansi rgb terminal tty
install size Estimated unpacked size across 17 packages.
2.8 MB
Includes dependencies.
dependencies 4 direct · 3 outdated
versions Latest published Nov 8, 2025
Mar 29, 2025
maintainers Registry package owners.
This is a thin wrapper around the popular
chalk colors library that adds support for:
Example import colorsOption from 'colors-option'
const exampleLibrary = ({ colors, ... otherLibraryOptions }) => {
const chalk = colorsOption ({ colors })
console. log (chalk. red ( 'example' ))
} copy
Install npm install colors-option copy This package works in Node.js >=18.18.0.
API
colorsOption(options?)
options
colors Whether colors should be displayed or not.
The default value depends on whether the stream supports colors.
Therefore, this is only meant to override that.
Supports the NO_COLOR and
NODE_DISABLE_COLORS
environment variables.
Does not guess colors detection based on the presence of a
--colors CLI flag . This
gives finer control and flexibility over how to expose this as a CLI flag.
level
1: 16 (4 bits)
2: 256 (8 bits)
3: 16 millions (24 bits)
The default value depends on
how many colors
the stream supports. Therefore, this is only meant to override
that.
stream Stream used to detect the default value of the colors and
level options.
This should be the file or terminal where the colors are output.
See also
Support Everyone is welcome regardless of personal background. We enforce a
Code of conduct in order to promote a positive and
inclusive environment.
Contributing This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
guidelines . Pull requests are welcome!