# proxyquire-stub-lambda-class

> lambda class to be used with proxyquire

Latest version **0.0.1** (published 2018-02-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install proxyquire-stub-lambda-class
pnpm add proxyquire-stub-lambda-class
yarn add proxyquire-stub-lambda-class
bun add proxyquire-stub-lambda-class
```

## 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.1 |
| Published | 2018-02-02 |
| First published | 2018-02-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jesus Cereceres |
| Maintainers | cereceres |
| Keywords | proxyquire, lambda, aws, class |

## Links

- npm: https://www.npmjs.com/package/proxyquire-stub-lambda-class
- Repository: https://github.com/Cereceres/proxyquire-stub-lambda-class
- Homepage: https://github.com/Cereceres/proxyquire-stub-lambda-class#readme
- Issues: https://github.com/Cereceres/proxyquire-stub-lambda-class/issues
- npm.io page: https://npm.io/package/proxyquire-stub-lambda-class

## Dependencies (1)

- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.188.0

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

- 0.0.1 (latest) — 2018-02-02

## README

# proxyquire-stub-lambda-class
stub lambda aws class to proxyquire

# Support

|method|support|specification|
|---|---|---|
|invoke|true|not return AWS.Request instance, only can be called with cb or promise property|

# Usage 

```js
const proxyquire = require('proxyquire')
const stubToLambda =  require('proxyquire-stub-lambda-class')

const paramsToExpect = {
     FunctionName:'FunctionName',
     Qualifier:'$LATEST',
     InvocationType:'RequestResponse',
     Payload: 'string',
     LogType: 'Tail'
}

const PayloadToReturn = {}

const options = {
    error: 'error to return'
    FunctionError: 'FunctionError',
    LogResult: 'base64 string',
    StatusCode : 'http code status'
}
const moduleUsingLambdaAWSClass = proxyquire('path/to/module',{
    'aws-sdk':{
        Lambda: stubToLambda(paramsToExpect, PayloadToReturn, options)
        // you can extend the class to your class
        }

moduleUsingLambdaAWSClass //any call to lambda is mocked

// Class example

lambda = new StubToLambda(paramsToExpect, PayloadToReturn, options)

lambda.invoke(params, (err, data)=>{/***callback***/}) // or
lambda.invoke(params).promise() // return a promise
// if params is not equal to paramsToExpect throw a error
})

```


stubToLambda(paramsToExpect, PayloadToReturn[, options])-> Lambda Class

    options = {
        error,
        FunctionError,
        LogResult,
        StatusCode
    }

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