# @jameslnewell/logger

> A logging library.

Latest version **3.0.1** (published 2019-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jameslnewell/logger
pnpm add @jameslnewell/logger
yarn add @jameslnewell/logger
bun add @jameslnewell/logger
```

## 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 | 3.0.1 |
| Published | 2019-01-14 |
| First published | 2019-01-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 219.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | jameslnewell |

## Links

- npm: https://www.npmjs.com/package/@jameslnewell/logger
- npm.io page: https://npm.io/package/@jameslnewell/logger

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.384.0
- [caller-path](https://npm.io/package/caller-path.md) ^2.0.0
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^4.0.0
- [aws-sdk-mock](https://npm.io/package/aws-sdk-mock.md) ^4.3.0
- [string-to-color](https://npm.io/package/string-to-color.md) ^2.0.1

## Recent versions

- 3.0.1 (latest) — 2019-01-14
- 3.0.0 — 2019-01-14
- 2.1.2 — 2019-01-14
- 2.1.1 — 2019-01-14
- 2.1.0 — 2019-01-14
- 2.0.0 — 2019-01-13
- 1.0.0 — 2019-01-10

## README

# @jameslnewell/logger

[![CircleCI](https://circleci.com/gh/jameslnewell/logger/tree/master.svg?style=svg)](https://circleci.com/gh/jameslnewell/logger/tree/master)

A logging library.

## Installation

```sh
yarn add @jameslnewell/logger
```

## Usage

### Using a logger
```js
import logger from '@jameslnewell/logger';

logger.info('Server is listening on http://localhost:3000');
```

### Using an extended logger
```js
import logger from '@jameslnewell/logger';

const log = logger.extend('my-server');

log.info('Server is listening on http://localhost:3000');
```

### Adding the time to the logs
```js
import logger, {time} from '@jameslnewell/logger';

logger.use(time());
```

### Adding the version to the logs
```js
import logger, {version} from '@jameslnewell/logger';

logger.use(version());
```

### Adding a custom field to the logs
```js
import logger from '@jameslnewell/logger';

logger.use(log => ({...log, foo: 'bar'}));
```

### Filtering the logs
```js
import logger, {Level, filter} from '@jameslnewell/logger';

logger.use(filter(log => log.level === Level.error));
```

### Writing logs to the console
```js
import logger, {ConsoleOutputStream} from '@jameslnewell/logger';

logger.pipe(new ConsoleOutputStream());
```

### Writing logs to a file
```js
import logger, {FileOutputStream} from '@jameslnewell/logger';

logger.pipe(new FileOutputStream());
```

### Writing logs to a file on error
```js
import logger, {MemoryOutputStream} from '@jameslnewell/logger';

const logs = logger.pipe(new MemoryOutputStream());
try {
  // do stuff here
} catch (error) {
  logger.error(error);
  fs.WritingFileSync('app.log', logs);
}
```

### Writing logs to CloudWatch
```js
import logger, {CloudwatchOutputStream} from '@jameslnewell/logger';

logger.pipe(new CloudwatchOutputStream({
  group: 'my-group',
  stream: 'my-stream',
}));
```

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