# cout

> A basic JavaScript console utility with sprintf and colors support.

Latest version **0.0.6** (published 2014-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install cout
pnpm add cout
yarn add cout
bun add cout
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2014-10-13 |
| First published | 2014-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | iwatakeshi |
| Maintainers | iwatakeshi |
| Keywords | debug, console, utility, cout, print |

## Links

- npm: https://www.npmjs.com/package/cout
- Repository: https://github.com/iwatakeshi/cout
- Issues: https://github.com/iwatakeshi/cout/issues
- npm.io page: https://npm.io/package/cout

## Dependencies (4)

- [colors](https://npm.io/package/colors.md) ^1.0.3
- [kawari](https://npm.io/package/kawari.md) 0.0.1
- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [moment](https://npm.io/package/moment.md) ^2.8.3

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2014-10-13
- 0.0.5 — 2014-10-10
- 0.0.4 — 2014-10-10
- 0.0.3 — 2014-10-10
- 0.0.2 — 2014-10-10
- 0.0.1 — 2014-10-10

## README

cout
====
[![License](http://img.shields.io/npm/l/cout.svg)](http://img.shields.io/npm/l/cout.svg)
[![Dependencies](http://img.shields.io/david/iwatakeshi/cout.svg)](http://img.shields.io/david/iwatakeshi/cout.svg)
[![Downloads](http://img.shields.io/npm/dm/cout.svg)](http://img.shields.io/npm/dm/cout.svg)
[![Version](http://img.shields.io/npm/v/cout.svg)](http://img.shields.io/npm/v/cout.svg)

[![NPM](https://nodei.co/npm/cout.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/cout/)

A basic JavaScript console utility with sprintf and colors support.

##Install

```bash
sudo npm install --save cout
```

##Usage

```js
var cout = require('cout'),
//sprintf(..., ...) or use cout.kawari(..., ...)
sprintf = cout.kawari;

//configure (optional)
cout.config({
	cout: ['warn', 'error']
});

//will print on a single line (no color)
cout("Hello", "World", {hello: "world"}, ['hello', 'world'], 1,2,3).end();
//will print on newlines (can be changed through cout.config()) (no color)
cout("Hello", "World", {hello: "world"}, ['hello', 'world'], 1,2,3).endl();

//will print with new line color (see themes for color/level)
cout("Hello", "World", {hello: "world"}, ['hello', 'world'], 1,2,3).warn();

//you can customize the background and styles (see styles)
cout("Hello", "World", {hello: "world"}, ['hello', 'world'], 1,2,3).warn({bg: 'green', style: 'bold'});

//sprintf from the top level (to keep things simple internally)
cout(sprintf('...', '...')).warn();
```

##Methods

* `end()`
* `endl()`
* `warn()`
* `data()`
* `debug()`
* `error()`
* `help()`
* `info()`
* `input()`
* `prompt()`
* `silly()`
* `verbose()`

##Config
The following are the default values but can be changed

```js
//configure
cout.config({
	....options....
});

{
	//specify which level (Array or String) to display
	//by default '*' means display all levels
	//if you pass a level array and want to display end() and endl()
	//just add 'normal' to the array.
	cout: ['*'],
	//default theme/colors/levels
	theme: {
	  data: 'grey',
	  debug: 'blue',
	  error: 'red',
	  help: 'cyan',
	  info: 'green',
	  input: 'grey',
	  prompt: 'grey',
	  silly: 'rainbow',
	  verbose: 'cyan',
	  warn: 'yellow',
	},
	//used for pretty printing json/plain objects
	json:{
	    space: 2
	},
	//specify the number of new lines.
	newline: '\n'
}


```

##Styles

####Usage

```js
//use style key
{style: ...}
```

* reset
* bold
* dim
* italic
* underline
* inverse
* hidden
* strikethrough

##Background color

####Usage

```js
//use bg key
{bg: ...}
```
* black
* red
* green
* yellow
* blue
* magenta
* cyan
* white

##Time stamp

cout uses Moment.js for time stamps. See [Moment.js](http://momentjs.com/)' docs for formatting and locales.

###Usage

Default: false

Acceptable types: Boolean, Plain Object

```js
//boolean
true or false

timestamp:{
	//format the time
	format:'dddd',
	//change the locale
	locale: 'ja',
	//spacing: can be tabs or spaces
	space: '\n'
}

```

##Changlog

*0.0.1*

* Initial commit

*0.0.2*

* Cleaned code and removed confusing debug statement.
* Updated readme

*0.0.3*

* Updated readme
* Removed unnecessary comments.

*0.0.4*

* Added node_modules to .gitignore

*0.0.5*

* Added boolean support. You can now set `{cout:...}` to `true` or `false`.

**0.0.6**

* Added time stamp support. You can pass a Boolean or configure the time stamp's locale and format by passing a plain Object.
* Added 'normal' level for end() and endl() when using an array with levels.

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