1.0.2 • Published 6 years ago

aws-sdk-mock-mate v1.0.2

Weekly downloads
6
License
MIT
Repository
github
Last release
6 years ago

aws-sdk-mock-mate

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Mock tool for aws sdk.

Install

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

Usage

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.
  • 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.

License

MIT