# winston-slacker

> Slack integration for Winston

Latest version **1.0.3** (published 2015-12-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install winston-slacker
pnpm add winston-slacker
yarn add winston-slacker
bun add winston-slacker
```

## 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.3 |
| Published | 2015-12-11 |
| First published | 2015-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Meerkats |
| Maintainers | craiglonsdale, jimmyhillis, meerkats |
| Keywords | slack, winston, log, slacker, meerkats, logger |

## Links

- npm: https://www.npmjs.com/package/winston-slacker
- Repository: https://github.com/meerkats/winston-slacker
- Homepage: https://github.com/meerkats/winston-slacker#readme
- Issues: https://github.com/meerkats/winston-slacker/issues
- npm.io page: https://npm.io/package/winston-slacker

## Dependencies (3)

- [request](https://npm.io/package/request.md) ^2.61.0
- [winston](https://npm.io/package/winston.md) ^1.0.1
- [util-extend](https://npm.io/package/util-extend.md) ^1.0.1

## 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

- 1.0.3 (latest) — 2015-12-11
- 1.0.2 — 2015-11-30
- 1.0.1 — 2015-10-14
- 1.0.0 — 2015-10-14

## README

# winston-slacker [![Build Status](https://travis-ci.org/meerkats/winston-slacker.svg)](https://travis-ci.org/meerkats/winston-slacker)
Slack integration for Winston

# Installing

```
$ npm install winston-slacker
```

This transport can be used like most standard Winston transports to send messages to a Slack channel.

## Options

Standard options are support as well as the following additions:
 - `webhook`: Your Slack channel's webhook URL
 - `channel`: The channel to send messages to (with the `#` like `#general`)
 - `username`: The username to use for the message in Slack
 - `iconUrl`: URL for Slackbot avatar
 - `iconImoji`: Emoji for Slackbot icon
 - `customFormatter`: Function used to format the message for Slack

```js
var winston = require('winston');
var winstonSlacker = require('winston-slacker');
var options = {
  // Set options up
};
winston.add(winstonSlacker, options);
```

# Tests

To run tests run `npm install` and then `npm test` from the root directory in your shell.

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