Giter Club home page Giter Club logo

typesafe-hapi's Introduction

typesafe-hapi

typesafe-hapi is a fork of hapi which aims to improve typesafety. More precisely, this is a fork of @types/hapi__hapi because it has just redefined the essential APIs of hapi.

typesafe-hapi currently matches the API of hapi 18.3.x. It was tested with TypeScript 3.4.5.

How it works

typesafe-hapi uses typesafe-joi to infer correct type from Joi schemas automatically. It uses possesed type information to typecheck:

  • request.query
  • request.payload
  • request.params
  • response

Example

const payloadSchema = Joi.object({
  user: Joi.object({
    name: Joi.string().required(),
    email: Joi.string().required(),
  }).required(),
}).required();

const querySchema = Joi.object({
  search: Joi.string().optional().allow('', null),
}).required();

const paramsSchema = Joi.object({
  id: Joi.number().required()
}).required();

const responseSchema = Joi.object({
  id: Joi.number().required(),
  name: Joi.string().required(),
  email: Joi.string().required(),
  search: Joi.string().optional().allow(null),
}).required();

server.route({
  method: 'POST',
  path: '/:id',
  options: {
    validate: {
      payload: payloadSchema,
      query: querySchema,
      params: paramsSchema,
    },
    response: {
      schema: responseSchema,
    },
  },
  handler(request) {
    // type of `payload` is automatically inferred based on `options.validate.payload` schema
    const payload = request.payload; // { user: { name: string; email: string; }; } 
    const query = request.query; // { search?: string | null | undefined; }
    const params = request.params; // { id: number; } 

    // return type is also typechecked based on `options.response.schema`
    return {
      id: params.id,
      name: payload.user.name, // string
      email: payload.user.email, // string
      search: query.search, // string | null | undefined
    };
  },
});

Neat, huh? See more examples in index.test-d.ts.

Usage

Import and use hapi from typesafe-hapi:

import * as Hapi from 'typesafe-hapi'

In order to avoid any compatibility issues, and to be able to use existing packages and plugins easily, you should create an alias for typesafe-hapi and rename it to just hapi. In your tsconfig.json:

{
  "compilerOptions": {
    // … other options
    "paths": {
      "hapi": ["node_modules/typesafe-hapi"],
      "joi": ["node_modules/typesafe-joi"]
    }
  }
}

typesafe-hapi's People

Contributors

typeofweb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

kbiedrzycki

typesafe-hapi's Issues

Update for hapi@19

This is such a great package - any chance it can be updated to v19 or modified to augment an arbitrary version of hapi as a peer dep?

Possibly related question: why doesn't the @types/hapi__hapi package do this kind of inference?

Thanks for your work on this!

Hapi update

I would like to know if there is an update planned in order support Hapi v20.1 ? I would really like to use it my project but there seems to be a compatibility issue.

Thank you for your work !

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.