# rapid-console

> simple, no setting console for command line tool

Latest version **1.0.1** (published 2019-07-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install rapid-console
pnpm add rapid-console
yarn add rapid-console
bun add rapid-console
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-07-01 |
| First published | 2019-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | dzg |
| Maintainers | melody_dzg |
| Keywords | js, console, cmd |

## Links

- npm: https://www.npmjs.com/package/rapid-console
- Repository: https://github.com/DZG-MELODY/d-console
- Homepage: https://github.com/DZG-MELODY/d-console#readme
- Issues: https://github.com/DZG-MELODY/d-console/issues
- npm.io page: https://npm.io/package/rapid-console

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [chalk-animation](https://npm.io/package/chalk-animation.md) ^1.6.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.1 (latest) — 2019-07-01
- 1.0.0 — 2019-06-24
- 0.1.2 — 2019-01-29
- 0.1.1 — 2019-01-25

## README

# rapid-console

- simple, unique style console for command line tool.
- you need not to consider which color to set.

![rapid console](./assets/example.png)

[changelog>>>>](https://github.com/DZG-MELODY/rapid-console/blob/master/CHANGELOG.md)

## install

```bash
npm i rapid-console -D
```

## usage

```js

// commonjs

const RConsole = require("rapid-console");

RConsole.note("ABC...");

//...
```

or

```typescript

// typescript

import RConsole from "rapid-console";

RConsole.note("ABC...");

//...
```

## API

### title(message)

console a title with outline

- message `string`

---

### note(message)

console a note message

- message `string`

---

### info(message)

console a info message

- message `string`

---

### success(message)

console a success message

- message `string`

---

### warning(message)

console a warning message

- message `string`

---

### error(message)

console an error message

- message `string`

---

### plain(message,[bgColor,fontColor])

console a plain message with custom color style

- message `string`
- bgColor `string`
- fontColor `string`

**note**: color must be one of these:
"black"
| "white"
| "green"
| "yellow"
| "blue"
| "red"
| "cyan"

---

### line(n)

console lines with no content

- n: `number`

---

### split(n,placeHolder)

console split line with spec placeholder

- n: `number` the count of place holder, default is 20
- placeHolder: `string` place holder string, default is "\*"

---

### **async** colorFlash(message,time)

console a message using colorful flash animation

- message: `string`
- time: `number` the duration of the animation

**note** the method is an async function

---

## related

### [chalk](https://github.com/chalk/chalk)

### [chalk-animate](https://github.com/bokub/chalk-animation)

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