npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@schibsted/middy-caching-headers

v4.0.4

Published

Middy middleware for adding caching headers to success response and errors

Downloads

393

Readme

Middy caching headers middleware

github checks current version @ npm weekly downloads @ npm minified size

Caching headers middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

This middleware sets HTTP caching headers, necessary for making the requests cache'able both in browsers and reverse proxies.

Sets headers in after and onError phases.

Install

To install this middleware you can use NPM:

npm install --save @schibsted/middy-caching-headers

Options

  • success (object) - configuration for the successful requests
  • errors (object) - configuration for the error requests based on the statusCode

Every section of the config contains 3 properties:

  • directive (string, optional) - response directive e.g. must-revalidate, public etc.
  • clientTime (int) - time to set max-age for
  • serverTime (int) - time to set s-maxage for

See the sample usage below.

Sample usage

const middy = require('@middy/core');
const cors = require('@schibsted/middy-caching-headers');

const handler = middy(async () => ({
        statusCode: 200,
        body: JSON.stringify({ foo: 'bar' }),
    }));

handler
  .use(cors({
        success: {
            directive: null,
            serverTime: 3600,
            clientTime: 600,
        },
        errors: {
            default: {
                directive: null,
                serverTime: 5,
                clientTime: 5,
            },
            502: false,
            404: {
                directive: null,
                serverTime: 600,
                clientTime: 600,
            },
        },
    }));

// when Lambda runs the handler...
handler({}, {}, (_, response) => {
  expect(response).toEqual({
    statusCode: 200,
    headers:  {
        'cache-control': 'max-age=600,s-maxage=3600',
        'surrogate-control': 'max-age=3600',
    },
    body: JSON.stringify({ foo: 'bar' }),
  })
})

Contributing

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