# @mirania/console-colors

> useful console text coloring methods

Latest version **1.0.2** (published 2019-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @mirania/console-colors
pnpm add @mirania/console-colors
yarn add @mirania/console-colors
bun add @mirania/console-colors
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-12-28 |
| First published | 2019-12-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Me |
| Maintainers | mirania |
| Keywords | console, colors, nodejs, cmd, browser, oop, text, background |

## Links

- npm: https://www.npmjs.com/package/@mirania/console-colors
- Repository: https://github.com/Mirania/console-colors
- Homepage: https://github.com/Mirania/console-colors#readme
- Issues: https://github.com/Mirania/console-colors/issues
- npm.io page: https://npm.io/package/@mirania/console-colors

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2019-12-28
- 1.0.1 — 2019-12-28
- 1.0.0 — 2019-12-28

## README

# Console-colors

Improve the JS console's capabilities with pretty colors.

```
npm i @mirania/console-colors
```

The module inherits all functionality from the native ```console```, so you can safely replace it as such:

```js 
const console = require("@mirania/console-colors");
```

-----

## Features

  - methods for coloring a line of text: ```bold(), black(), red(), green(), gold(), blue(), magenta(), cyan(), white(), grey(), gray(), ruby(), leaf(), yellow(), ocean(), pink(), sky(), light()```
  
  - method to create a string with the intended colors: ```format()```, which accepts a **style**. A **style** is an object that can have 2 keys:
  
      - **text**, which may be any of the colors mentioned above
      
      - **bg** or **background**, any of the colors above except **bold**
  
![](https://i.imgur.com/fineExl.png)

---
_Source: https://npm.io/package/@mirania/console-colors · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._