An open API service indexing awesome lists of open source software.

https://github.com/futurestudio/hapi-request-user

hapi plugin adding the “request.user” shortcut for “request.auth.credentials”
https://github.com/futurestudio/hapi-request-user

decorates future-studio-university futurestudio hapi hapi-auth hapi-plugin hapijs

Last synced: 4 months ago
JSON representation

hapi plugin adding the “request.user” shortcut for “request.auth.credentials”

Awesome Lists containing this project

README

          


hapi-request-user logo





hapi plugin that shortcuts “request.auth.credentials” to “request.user”





Installation ·
Usage ·







Build Status
hapi-request-user Version
Monthly downloads



Follow @marcuspoehls for updates!


------

Development of this hapi plugin is supported by Future Studio University 🚀


Join the Future Studio University and Skyrocket in Node.js

------

## Introduction
A hapi plugin that shortcuts access to the authenticated user from `request.auth.credentials` to `request.user`.

Access the authenticated user in request lifecycle methods, like this:

```js
{
method: 'GET',
path: '/authenticated-user',
handler: (request, h) => {
return request.user // instead of "request.auth.credentials"
}
}
```

## Requirements
> **hapi v17** and **Node.js v8 (or newer)**

This plugin requires **hapi v17** (or later) and uses async/await which requires **Node.js v8 or newer**.

## Installation
Add `hapi-request-user` as a dependency to your project:

```bash
npm i hapi-request-user
```

## Usage
Register the `hapi-request-user` plugin and you’re done:

```js
await server.register({
plugin: require('hapi-request-user'),
})
```

## Feature Requests
Do you miss a feature? Please don’t hesitate to
[create an issue](https://github.com/futurestudio/hapi-request-user/issues) with a short description of your desired addition to this plugin.

## Links & Resources

- [hapi tutorial series](https://futurestud.io/tutorials/hapi-get-your-server-up-and-running) with 100+ tutorials

## 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](https://futurestud.io)

---

> [futurestud.io](https://futurestud.io)  · 
> GitHub [@futurestudio](https://github.com/futurestudio/)  · 
> Twitter [@futurestud_io](https://twitter.com/futurestud_io)