Socket
Socket
Sign inDemoInstall

hapi-class-extension-points

Package Overview
Dependencies
2
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    hapi-class-extension-points

hapi plugin that registers lifecycle extension points from class methods


Version published
Maintainers
1
Install size
1.39 MB
Created

Changelog

Source

2.1.0 - 2020-06-22

Added

  • TypeScript types for the provided server.extClass decoration

Updated

  • bump dependencies

Readme

Source
hapi-class-extension-points logo

Use class methods to add lifecycle extension points to your hapi server.


Installation · Usage · Contribute



Build Status Known Vulnerabilities hapi-class-extension-points Version Monthly downloads

Follow @marcuspoehls for updates!


The Future Studio University supports development of this hapi plugin 🚀
Join the Future Studio University and Skyrocket in Node.js


Introduction

This hapi plugin adds the server.extClass(class) decoration to register lifecycle extensions from class methods.

Requirements

hapi v19 (or later) and Node.js v12 (or newer)

This plugin requires hapi v19 (or later) and Node.js v12 or newer.

Compatibility

Major Releasehapi.js versionNode.js version
v2>=17 hapi>=12
v1>=17 hapi>=8

Installation

Add hapi-class-extension-points as a dependency to your project:

npm i hapi-class-extension-points

Usage

Register hapi-class-extension-points to your hapi server. This will decorate the hapi server with a server.extClass() method:

await server.register({
  plugin: require('hapi-class-extension-points')
})

// went smooth like chocolate :)
// now your hapi server supports 'server.extClass(class MyMiddleware {})'

Having the plugin registered, you can now write your lifecycle extension points as classes:

class RateLimiting {
  constructor (server) {
    this.server = server
  }

  async onRequest (request, h) {
    // rate limit the request

    await this.handle(request)

    return h.continue
  }

  async handle (request) {
    // this is a private method that won't be registered as a lifecycle extension
  }

  onPreResponse (request, h) {
    // add rate limiting headers

    return h.continue
  }
}

server.extClass(RateLimiting)

That's it! The constructor of your class receives the hapi server. You can then store it as a class property and use it when needed!

Enjoy!

Contributing

  1. Create a fork
  2. Create your feature branch: git checkout -b my-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request 🚀

License

MIT © Future Studio


futurestud.io  ·  GitHub @futurestudio  ·  Twitter @futurestud_io

Keywords

FAQs

Last updated on 22 Jun 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc