Git Product home page Git Product logo

hapi-etagger's Introduction

hapi-etagger

Hapi server plug-in for etags and HTTP 304 support. It utilizes the popular etag library.

Build Status Coverage Status node code style License Status

Tested with

  • Hapi 20 on Node 12/14/15
  • Hapi 19 on Node 12/14/15

Install

npm install hapi-etagger

Purpose

This plug-in provides a simple way to support etags and HTTP 304.

By default, it adds etags and HTTP 304 support to all requests that meet the following criteria:

  • method is GET
  • status code is 2xx
  • response payload is a String, a stringifyable object or a Buffer

It is possible to opt-out.

Usage

Register the plugin with Hapi server like this:

const Hapi = require('@hapi/hapi');
const etags = require('hapi-etagger');

const server = new Hapi.Server({
  port: 3000,
});

const provision = async () => {
  await server.register(etags);
  // ...
  await server.start();
};

provision();

You can opt-out by route configuration, e.g.:

server.route({
  method: 'GET',
  path: '/example/{id}',
  options: {
    // ...
    plugins: {
      'hapi-etagger': {
        enabled: false, // opt-out
      },
    },
  },
  // ...
});

hapi-etagger's People

Contributors

dependabot[bot] avatar frankthelen avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

vasilevich

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.