# serverless-offline-msk

> A serverless offline plugin that enables AWS MSK events

Latest version **1.0.0** (published 2022-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install serverless-offline-msk
pnpm add serverless-offline-msk
yarn add serverless-offline-msk
bun add serverless-offline-msk
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-09-14 |
| First published | 2022-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16.0.0 |
| Dependencies | 3 |
| Unpacked size | 178.8 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Luke Evers |
| Maintainers | lukevers |
| Keywords | serverless-offline-msk, serverless-offline, serverless, serverless-plugin, serverless-offline-plugin, lambda, kafka, consumer, aws-msk, msk, sls |

## Links

- npm: https://www.npmjs.com/package/serverless-offline-msk
- Repository: https://github.com/lukevers/serverless-offline-msk
- Homepage: https://github.com/lukevers/serverless-offline-msk#readme
- Issues: https://github.com/lukevers/serverless-offline-msk/issues
- npm.io page: https://npm.io/package/serverless-offline-msk

## Dependencies (3)

- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.1214.0
- [kafkajs](https://npm.io/package/kafkajs.md) ^2.2.0
- [aws-lambda](https://npm.io/package/aws-lambda.md) ^1.0.7

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-09-14

## README

# serverless-offline-msk

A serverless offline plugin that enables AWS MSK events.

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
[![npm version](https://badge.fury.io/js/serverless-offline-msk.svg)](https://badge.fury.io/js/serverless-offline-msk)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> **Note**
>
> Something not working? Open an [issue](https://github.com/lukevers/serverless-offline-msk/issues). Pull requests welcome.

## Getting Started

### Example

See the [./examples](./examples/) folder for fully built out examples.

### Installation

Install the plugin:

```bash
# NPM or Yarn examples below:

npm install --save-dev serverless-offline-msk
yarn add -D serverless-offline-msk
```

In your `serverless.yml` we'll want to add the plugin after [serverless-offline](https://github.com/dherault/serverless-offline):

```yml
plugins:
  - serverless-offline
  - serverless-offline-msk
```

### Plugin Configuration

```yml
custom:
  serverless-offline-msk:
    allowAutoTopicCreation: true # If we can create topics in kafka automatically
    brokers: # list of brokers to use for kafka
      - "kafka:19092" # this example here is from a docker compose example in examples
```

### Function Event Configuration

The supported options are the same that are supported by serverless and MSK. See [the serverless docs](https://www.serverless.com/framework/docs/providers/aws/events/msk) for more information.

```yml
functions:
  consumerName:
    events:
      - msk: # list of MSK events.
          arn: 'arn:*' # requried! in AWS you would use a real MSK ARN, but this can be anything locally
          topic: some_topic_name # required! whatever the topic name is.
          batchSize: 1
          startingPosition: LATEST
          enabled: false # this will turn it off
```

## LICENSE

See [LICENSE](./LICENSE) for more info.

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