# log-pose

> Helps you to not get lost

Latest version **0.4.9** (published 2023-07-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install log-pose
pnpm add log-pose
yarn add log-pose
bun add log-pose
```

## 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.4.9 |
| Published | 2023-07-16 |
| First published | 2017-05-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 3 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | pateketrueke |

## Links

- npm: https://www.npmjs.com/package/log-pose
- npm.io page: https://npm.io/package/log-pose

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [cli-width](https://npm.io/package/cli-width.md) ^4.0.0
- [pretty-ms](https://npm.io/package/pretty-ms.md) ^3.2.0

## Recent versions

- 0.4.9 (latest) — 2023-07-16
- 0.4.8 — 2023-07-16
- 0.4.7 — 2021-08-19
- 0.4.6 — 2021-03-03
- 0.4.5 — 2021-02-26
- 0.4.4 — 2021-02-26
- 0.4.3 — 2021-02-26
- 0.4.2 — 2021-02-26
- 0.4.1 — 2021-02-25
- 0.4.0 — 2021-02-25
- 0.3.7 — 2020-09-04
- 0.3.6 — 2020-09-04
- 0.3.5 — 2019-10-20
- 0.3.4 — 2018-12-05
- 0.3.3 — 2018-01-02
- … 9 more at https://npm.io/package/log-pose/versions

## README

# LogPose

[![NPM version](https://badge.fury.io/js/log-pose.svg)](http://badge.fury.io/js/log-pose)
[![Build status](https://github.com/pateketrueke/log-pose/workflows/build/badge.svg)](https://github.com/pateketrueke/log-pose/actions)
[![codecov](https://codecov.io/gh/pateketrueke/log-pose/branch/master/graph/badge.svg)](https://codecov.io/gh/pateketrueke/log-pose)


Helps you to not get lost.

```bash
$ npm i log-pose --save
# or `yarn add log-pose`
```

## API

Import the module and retrieve a shared logger instance.

```js
import LogPose from 'log-pose';

// define logging level
LogPose.setLevel('verbose');

// get shared logger instance
const log = LogPose.getLogger();

// calling `newLogger()` returns a single method
const fail = LogPose.newLogger('my-app', 'verbose');
```

- `pause()` — Pause the logging output
- `resume()` — Resume the logging output
- `setLevel(type: String|Boolean)` — Set a logging level to disable/enable verbs; if `false` is given logging gets disabled
- `setLogger([stdout: Object])` — Set the standard-output for logging; if any _falsy_ value is given, then the entire logging is disabled. Given `stdout` is used to output log messages
- `getLogger([depth: Number[, stdout: Object]])` — Returns a shared logger instance; `depth` is used on status formatting
- `newLogger(prefix: String[, level: String|Number[, depth: Number, stdout: Object]])` — Returns a single logging method; actually, the shared logger is built from those methods. Methods are prefixed and receive a base level and depth; their output is skipped if given level is above the currently defined

> Log levels are `info`, `debug` and `verbose`.

### Logger

It's a function that can print statuses:

```js
// single status
log('testing');

// prefixed status
log('kind', 'value');

// async status
async function main() {
  // single task delayed
  await log('long task', () => new Promise(resolve => setTimeout(resolve, 1000)));

  // prefixed task delayed
  await log('kind', 'value', () => new Promise(resolve => setTimeout(resolve, 1000)));

  // prefixed task delayed, with callback
  await log('write', 'filepath', done => setTimeout(() => {
    // custom feedback on logs
    done('filepath', 'failed', 'fail');
  }, 1000));
}

main();
```

Also, it have some methods:

- `printf(...)` — Prints always, with formatting enabled
- `write(...)` — Prints always, without formatting
- `info(...)` — Prints if level is `> 0`
- `debug(...)` — Prints if level is `>= 1`
- `verbose(...)` — Prints if level is `>= 2`
- `isInfo()` — Returns `true` if level is `> 0`
- `isDebug()` — Returns `true` if level is `>= 1`
- `isVerbose()` — Returns `true` if level is `>= 2`
- `isEnabled()` — Returns `true` if level is `> 0`

Formatting works calling built-in `util.format()` on printing, e.g.

```js
log.info('{%info.bgBlue.white Text with spaces and values: %s%}\n', 42);
```

Available symbols are:

- `tick` → ✔
- `cross` → ✖
- `star` → ★
- `line` → ─
- `info` → ➲
- `reload` → ↺
- `pointer` → ›
- `warning` → ⚠

Built-in types are:

- `exception` → `line.bgRed.bold`
- `featured` → `star.bgBlue.bold`
- `failure` → `warning.bgRed.white`
- `success` → `line.green`
- `error` → `line.red`
- `tip` → `star.yellow`
- `link` → `line.cyan`
- `item` → `line.gray`
- `warn` → `warning.bold`
- `info` → `info.blue`
- `fail` → `cross.red`
- `wait` → `reload.gray`
- `end` → `tick.cyan`
- `log` → `pointer.gray`
- `ok` → `tick.green`

Using these you can short your code:

```js
log.info('{%ok Text with spaces and values: %s%}\n', 42);
```

> Color names are defined by [Chalk](https://github.com/chalk/chalk).

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