# aws-sdk-mock-mate

> Mock tool for aws sdk.

Latest version **1.0.2** (published 2018-09-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install aws-sdk-mock-mate
pnpm add aws-sdk-mock-mate
yarn add aws-sdk-mock-mate
bun add aws-sdk-mock-mate
```

## 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.2 |
| Published | 2018-09-16 |
| First published | 2018-09-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 0 |
| Unpacked size | 10 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | ngot |
| Maintainers | ngot |
| Keywords | aws, sdk, mock |

## Links

- npm: https://www.npmjs.com/package/aws-sdk-mock-mate
- Repository: https://github.com/egg-aws/aws-sdk-mock-mate
- Homepage: https://github.com/egg-aws/aws-sdk-mock-mate#readme
- Issues: https://github.com/egg-aws/aws-sdk-mock-mate/issues
- npm.io page: https://npm.io/package/aws-sdk-mock-mate

## 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.2 (latest) — 2018-09-16
- 1.0.1 — 2018-09-16
- 1.0.0 — 2018-09-16

## README

# aws-sdk-mock-mate

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/aws-sdk-mock-mate.svg?style=flat-square
[npm-url]: https://npmjs.org/package/aws-sdk-mock-mate
[travis-image]: https://api.travis-ci.com/egg-aws/aws-sdk-mock-mate.svg
[travis-url]: https://travis-ci.com/egg-aws/aws-sdk-mock-mate
[codecov-image]: https://img.shields.io/codecov/c/github/egg-aws/aws-sdk-mock-mate.svg?style=flat-square
[codecov-url]: https://codecov.io/github/egg-aws/aws-sdk-mock-mate?branch=master
[david-image]: https://img.shields.io/david/egg-aws/aws-sdk-mock-mate.svg?style=flat-square
[david-url]: https://david-dm.org/egg-aws/aws-sdk-mock-mate
[snyk-image]: https://snyk.io/test/npm/aws-sdk-mock-mate/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/aws-sdk-mock-mate
[download-image]: https://img.shields.io/npm/dm/aws-sdk-mock-mate.svg?style=flat-square
[download-url]: https://npmjs.org/package/aws-sdk-mock-mate

Mock tool for aws sdk.

## Install

```bash
$ npm i aws-sdk-mock-mate --save
```

## Usage

```js
const mock = require('aws-sdk-mock-mate');
const AWS = require('aws-sdk');

mock(AWS, 'dynamodb', '2012-08-10', 'describeLimits', {
  statusCode: 200,
  body: {
    AccountMaxReadCapacityUnits: 100,
    AccountMaxWriteCapacityUnits: 100,
    TableMaxReadCapacityUnits: 100,
    TableMaxWriteCapacityUnits: 100
  },
});

dynamodbClient.describeLimits()
  .promise()
  .then(result => {
    console.log(result);
    mock.restore(AWS, 'dynamodb', '2012-08-10', 'describeLimits');
  }).catch(err => console.log(err));

```

## API

- `mock(aws, serviceName, version, methodName, replyBody)` mock a aws service method with provided response body.
  - `aws` { Object } a valid AWS SDK object.
  - `serviceName` { String } a valid AWS service name.
  - `version` { String } a valid AWS service version string.
  - `methodName` { String } a valid service method name.
  - `replyBody` { Object } mocked reply.
    - `statusCode` { Number } status code. 200 for normal, 400 for exception.
    - `body` { Object } response body. seem more at [examples](https://github.com/aws/aws-sdk-js/blob/master/apis/dynamodb-2012-08-10.examples.json).
- `mock.restore(aws, serviceName, version, methodName)` restore the mock operation.
  - `aws` { Object } a valid AWS SDK object.
  - `serviceName` { String } optional. a valid AWS service name.
  - `version` { String } optional. a valid AWS service version string.
  - `methodName` { String } optional. a valid service method name.

## Questions & Suggestions

Please open an issue [here](https://github.com/egg-aws/aws-sdk-mock-mate/issues).

## License

[MIT](LICENSE)

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