Novices Performing Miracles
    Have ideas to improve npm?Join in the discussion! »

    @middy/do-not-wait-for-empty-event-loop
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    Middy do-not-wait-for-empty-event-loop middleware

    Middy logo

    "Do not wait for empty event loop" middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

    This middleware sets context.callbackWaitsForEmptyEventLoop property to false. This will prevent Lambda from timing out because of open database connections, etc.

    Install

    To install this middleware you can use NPM:

    npm install --save @middy/do-not-wait-for-empty-event-loop

    Options

    By default the middleware sets the callbackWaitsForEmptyEventLoop property to false only in the before phase, meaning you can override it in handler to true if needed. You can set it in all steps with the options:

    • runOnBefore (defaults to true) - sets property before running your handler
    • runOnAfter (defaults to false)
    • runOnError (defaults to false)

    Sample usage

    import middy from '@middy/core'
    import doNotWaitForEmptyEventLoop from '@middy/do-not-wait-for-empty-event-loop'
    
    const handler = middy((event, context) => {
      return {}
    })
    
    handler.use(doNotWaitForEmptyEventLoop({runOnError: true}))
    
    // When Lambda runs the handler it gets context with callbackWaitsForEmptyEventLoop property set to false
    
    handler(event, context, (_, response) => {
      t.is(context.callbackWaitsForEmptyEventLoop,false)
    })

    Middy documentation and examples

    For more documentation and examples, refers to the main Middy monorepo on GitHub or Middy official website.

    Contributing

    Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

    License

    Licensed under MIT License. Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the Middy team.

    FOSSA Status

    Install

    npm i @middy/do-not-wait-for-empty-event-loop

    DownloadsWeekly Downloads

    17,012

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    6.49 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar