https://github.com/hapipal/toys

The hapi utility toy chest
https://github.com/hapipal/toys

Last synced: 12 months ago
JSON representation

The hapi utility toy chest

• Host: GitHub
• URL: https://github.com/hapipal/toys
• Owner: hapipal
• License: other
• Created: 2017-02-06T05:10:47.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T04:57:05.000Z (about 3 years ago)
• Last Synced: 2025-04-11T23:18:07.890Z (about 1 year ago)
• Language: JavaScript
• Size: 132 KB
• Stars: 32
• Watchers: 6
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# toys

The hapi utility toy chest

[![Build Status](https://app.travis-ci.com/hapipal/toys.svg?branch=main)](https://app.travis-ci.com/hapipal/toys) [![Coverage Status](https://coveralls.io/repos/hapipal/toys/badge.svg?branch=main&service=github)](https://coveralls.io/github/hapipal/toys?branch=main)

Lead Maintainer - [Devin Ivy](https://github.com/devinivy)

## Installation

```sh

npm install @hapipal/toys

```

## Usage

> See also the [API Reference](API.md)

>

> Toys is intended for use with hapi v20+ and nodejs v16+ (_see v3 for lower support_).

Toys is a collection of utilities made to reduce common boilerplate in **hapi v20+** projects.

Below is an example featuring [`Toys.auth.strategy()`](API.md#toysauthstrategyserver-name-authenticate) and [`Toys.withRouteDefaults()`](API.md#toyswithroutedefaultsdefaults).  The [API Reference](API.md) is also filled with examples.

```js

const Hapi = require('@hapi/hapi');

const Boom = require('@hapi/boom');

const Toys = require('@hapipal/toys');

(async () => {

    const server = Hapi.server();

    // Make a one-off auth strategy for testing

    Toys.auth.strategy(server, 'name-from-param', (request, h) => {

        // Yes, perhaps not the most secure

        const { username } = request.params;

        if (!username) {

            throw Boom.unauthorized(null, 'Custom');

        }

        return h.authenticated({ credentials: { user: { name: username } } });

    });

    // Default all route methods to "get", unless otherwise specified

    const defaultToGet = Toys.withRouteDefaults({ method: 'get' });

    server.route(

        defaultToGet([

            {

                method: 'post',

                path: '/',

                handler: (request) => {

                    return { posted: true };

                }

            },

            {   // Look ma, my method is defaulting to "get"!

                path: '/as/{username}',

                options: {

                    auth: 'name-from-param', // Here's our simple auth strategy

                    handler: (request) => {

                        const username = request.auth.credentials?.user?.name;

                        return { username };

                    }

                }

            }

        ])

    );

    await server.start();

    console.log(`Now, go forth and ${server.info.uri}/as/your-name`);

})();

```