Wondering what’s next for npm?Check out our public roadmap! »

    @middy/s3-key-normalizer
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    Middy s3-key-normalizer middleware

    Middy logo

    S3 key normalizer middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

    Normalizes key names in s3 events.

    S3 events like S3 PUT and S3 DELETE will contain in the event a list of the files that were affected by the change.

    In this list the file keys are encoded in a very peculiar way (urlencoded and space characters replaced by a +). Very often you will use the key directly to perform operations on the file using the AWS S3 SDK, in which case it's very easy to forget to decode the key correctly.

    This middleware, once attached, makes sure that every S3 event has the file keys properly normalized.

    Install

    To install this middleware you can use NPM:

    npm install --save @middy/s3-key-normalizer

    Options

    This middleware does not have any option

    Sample usage

    import middy from '@middy/core'
    import s3KeyNormalizer from '@middy/s3-key-normalizer'
    
    const handler = middy((event, context) => {
      // use the event key directly without decoding it
      console.log(event.Records[0].s3.object.key)
    
      // return all the keys
      return event.Records.map(record => record.s3.object.key)
    })
    
    handler
      .use(s3KeyNormalizer())

    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/s3-key-normalizer

    DownloadsWeekly Downloads

    1,092

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    6.31 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar