# log-utils
> Tiny wrapper around ansi-colors to add colored symbols and a timestamp.
Latest version **1.0.0** (published 2018-11-18) · MIT license · 0 weekly downloads
## Install
```sh
npm install log-utils
pnpm add log-utils
yarn add log-utils
bun add log-utils
```
## 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.0 |
| Published | 2018-11-18 |
| First published | 2016-03-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.6 |
| Dependencies | 2 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Jon Schlinkert |
| Maintainers | doowb, jonschlinkert |
| Keywords | ansi, chalk, check, checkmark, cli, color, colors, command, console, cyan, error, green, info, line, log, red, stamp, success, terminal, time, time-stamp, timestamp, util, utility, utils, warn, warning, yellow |
## Links
- npm: https://www.npmjs.com/package/log-utils
- Repository: https://github.com/jonschlinkert/log-utils
- Issues: https://github.com/jonschlinkert/log-utils/issues
- npm.io page: https://npm.io/package/log-utils
## Dependencies (2)
- [time-stamp](https://npm.io/package/time-stamp.md) ^2.2.0
- [ansi-colors](https://npm.io/package/ansi-colors.md) ^3.2.1
## Alternatives
- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads
## Recent versions
- 1.0.0 (latest) — 2018-11-18
- 0.3.0 — 2018-08-01
- 0.2.1 — 2016-07-11
- 0.2.0 — 2016-07-11
- 0.1.5 — 2016-07-11
- 0.1.4 — 2016-05-03
- 0.1.3 — 2016-04-27
- 0.1.2 — 2016-04-21
- 0.1.1 — 2016-04-21
- 0.1.0 — 2016-03-13
## README
# log-utils [](https://www.npmjs.com/package/log-utils) [](https://npmjs.org/package/log-utils) [](https://npmjs.org/package/log-utils) [](https://travis-ci.org/jonschlinkert/log-utils)
> Tiny wrapper around ansi-colors to add colored symbols and a timestamp.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save log-utils
```
## Usage
```js
const log = require('log-utils');
```
## API
### [.error](index.js#L23)
Get a red error symbol.
**Example**
```js
console.log(log.error); //=> ✖
```
### [.info](index.js#L35)
Get a cyan info symbol.
**Example**
```js
console.log(log.info); //=> ℹ
```
### [.success](index.js#L47)
Get a green success symbol.
**Example**
```js
console.log(log.success); //=> ✔
```
### [.warning](index.js#L59)
Get a yellow warning symbol.
**Example**
```js
console.log(log.warning); //=> ⚠
```
### [.timestamp](index.js#L71)
Get a formatted timestamp.
**Example**
```js
console.log(log.timestamp); //=> [15:27:46]
```
### [.ok](index.js#L93)
Returns a formatted string prefixed by a green check.
**Example**
```js
console.log(log.ok(' foo'));
console.log(log.ok(' foo'));
console.log(log.ok(' foo'));
console.log(log.ok('foo'));
// Results in:
// ✔ foo
// ✔ foo
// ✔ foo
// ✔ foo
```
### [.heading](index.js#L112)
Make the given text bold and underlined.
**Example**
```js
console.log(log.heading('foo'));
// or
console.log(log.heading('foo', 'bar'));
```
### Colors
Available colors from [ansi-colors](https://github.com/doowb/ansi-colors):
## Changes
**v0.2.0 (2016-07-16)**
* `removed`: all spinner methods
**v0.1.5 (2016-07-16)**
* `added`: `.header` method
* `fixed`: `.ok` method, so that whitespace is respected
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
[ansi-colors](https://www.npmjs.com/package/ansi-colors): Easily add ANSI colors to your text and symbols in the terminal. A faster drop-in… [more](https://github.com/doowb/ansi-colors) | [homepage](https://github.com/doowb/ansi-colors "Easily add ANSI colors to your text and symbols in the terminal. A faster drop-in replacement for chalk, kleur and turbocolor (without the dependencies and rendering bugs).")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 23 | [jonschlinkert](https://github.com/jonschlinkert) |
| 5 | [doowb](https://github.com/doowb) |
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 17, 2018._
---
_Source: https://npm.io/package/log-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._