# winston-humanize-formatter

> Format winston logging in a human readable format

Latest version **0.1.4** (published 2019-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install winston-humanize-formatter
pnpm add winston-humanize-formatter
yarn add winston-humanize-formatter
bun add winston-humanize-formatter
```

## Health

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

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

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2019-11-19 |
| First published | 2019-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 71.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dominik König |
| Maintainers | koenig-dominik |
| Keywords | winston, logging, format, winstonjs, humanize, human, console, pretty |

## Links

- npm: https://www.npmjs.com/package/winston-humanize-formatter
- Repository: https://github.com/koenig-dominik/winston-humanize-formatter
- Homepage: https://github.com/koenig-dominik/winston-humanize-formatter#readme
- Issues: https://github.com/koenig-dominik/winston-humanize-formatter/issues
- npm.io page: https://npm.io/package/winston-humanize-formatter

## Dependencies (1)

- [triple-beam](https://npm.io/package/triple-beam.md) ^1.3.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.1.4 (latest) — 2019-11-19
- 0.1.3 — 2019-11-18
- 0.1.2 — 2019-11-18
- 0.1.1 — 2019-11-15
- 0.1.0 — 2019-11-15

## README

# Winston humanize formatter

Format winston logging in a human readable format

## Install

`npm install winston-humanize-formatter`

## Usage

You can either use the formatters directly or use one of the presets

```typescript
import { transports, createLogger } from 'winston';
import { presets } from 'winston-humanize-formatter';

createLogger({
  level: 'debug',
  format: presets.cli.dev,
  transports: [
    new transports.Console()
  ]
});
```

### available presets

```typescript
import { presets } from 'winston-humanize-formatter';

presets.cli.dev;
presets.cli.prod;
```

### available formatters

```typescript
import { formatter } from 'winston-humanize-formatter';

formatter.colorize({ keys: string[] });
formatter.join({ keys: string[] });
formatter.multiline({ keys: string[] });
formatter.padLevels({ keys: string[] });
formatter.prettyJson({ excludeKeys: string[], colorize?: boolean, depth?: number });
formatter.stacks({ cleanStackPaths: boolean });
```

## Examples

Preset cli dev
![CLI dev example](/screenshots/example-cli-dev.png?raw=true "CLI dev example")

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