# aws-event-mocks

> AWS Event mocks like SNS, S3, ect.

Latest version **0.0.0** (published 2018-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install aws-event-mocks
pnpm add aws-event-mocks
yarn add aws-event-mocks
bun add aws-event-mocks
```

## 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.0.0 |
| Published | 2018-03-01 |
| First published | 2018-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0 |
| Dependencies | 1 |
| Unpacked size | 16.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | serverless.com |
| Maintainers | hn2007 |
| Keywords | serverless, serverless framework |

## Links

- npm: https://www.npmjs.com/package/aws-event-mocks
- Repository: https://github.com/NarHakobyan/aws-event-mocks
- Homepage: https://github.com/NarHakobyan/aws-event-mocks#readme
- Issues: https://github.com/NarHakobyan/aws-event-mocks/issues
- npm.io page: https://npm.io/package/aws-event-mocks

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.13.1

## Recent versions

- 0.0.0 (latest) — 2018-03-01

## README

# AWS Event Mocks
A small library that includes details mocks of AWS Lambda event sources. Useful for use when unit testing your Lambda functions. Supported Event Sources are: SNS, API Gateway, S3, & Scheduled.

The library simply uses default event source mock templates and merge it with any overwrite you provide. [Check out the JSON template files](/events) to learn more about the data structure of each event source.

## Usage

### SNS

```js
const createEvent = require('aws-event-mocks');
const mocked = createEvent({
  template: 'aws:sns',
  merge: {
    Records: [{
      Sns: {
        Message: 'trigger-email'
      }
    }]
  }
});
```

### API Gateway

```js
const createEvent = require('aws-event-mocks');
const event = createEvent({
  template: 'aws:apiGateway',
  merge: {
    body: {
      first_name: 'Sam',
      last_name: 'Smith'
    }
  }
});
```

### S3

```js
const createEvent = require('aws-event-mocks');
const event = createEvent({
  template: 'aws:s3',
  merge: {
    Records: [{
      eventName: 'ObjectCreated:Put',
      s3: {
        bucket: {
          name: 'my-bucket-name'
        },
        object: {
          key: 'object-key'
        }
      }
    }]
  }
});
```

### Scheduled

```js
const createEvent = require('aws-event-mocks');
const event = createEvent({
  template: 'aws:scheduled',
  merge: {
    region: 'us-west-2'
  }
});
```

### Kinesis

```js
const createEvent = require('aws-event-mocks');
const event = createEvent({
  template: 'aws:kinesis',
  merge: {
    data: new Buffer('this is test data').toString('base64')
  }
});

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