Code Monkey home page Code Monkey logo

waffle's Introduction

Waffle - A fluent Fastify wrapper that makes HTTP servers stupidly easy

Install

npm i @twoojoo/waffle

Description

Waffle allows you to easily build an HTTP server using Fastyfy with a completely fluent syntax. It supports route types and schemas and all main Fastify features, while fully allowing to interact with the underlying Fastify instance.

It also comes shipped with some useful plugins such as rate limter, cors and json schema parser, to further decrease development time.

It's typescript first. If you provide json schemas (see this example), route types will be automatically inferred, achieving validation and type safety all at once!

Sample

import { Waffle } from "@twoojoo/waffle"

const server = Waffle({ logger: true })
	//all Fastify hooks available (at server, version, prefix or route level)
	.onRequest(async (req, rep) => console.log("1) on request hook"))
	.preParsing(async (req, rep) => console.log("2) pre parsing hook"))
	.preValidation(async (req, rep) => console.log("3) pre validation hook"))
	.preHandler(async (req, rep) => console.log("4) pre handler hook"))
	.preSerialization(async (req, rep) => console.log("5) pre serialization hook"))
	.onSend(async (req, rep) => console.log("6) on send hook"))
	.onError(async (req, rep) => console.log("6) on error hook"))
	.onResponse(async (req, rep) => console.log("6) on response hook"))
	.limiter({max: 1, timeWindow: 60*1000}) 
	.cors({/*..cors options..*/})

server.version(1) //API version management
	.prefix("users") //API resource management through route prefix
	.GET(":id").handler(async (req, rep) =>  /*...route logic..*/) // GET http://localhost:3001/v1/users/:id
	.DELETE(":id").handler(async (req, rep) =>   /*...route logic..*/) // DELETE http://localhost:3001/v1/users/:id

server.version(2)
	.prefix("customers") //prefix specific hooks and limiters
	.limiter({max: 1, timeWindow: 60*1000})
	.onRequest(async (req, rep) => console.log("on request customers hook")) 

	.GET(":id")  // GET http://localhost:3001/v1/customers/:id
	.handler(async (req, rep) =>  /*...route logic..*/)

	.POST()  // POST http://localhost:3001/v1/customers
	.bodySchema(bodySchema) //route json schema both for validation and type safety
	.handler(async (req, rep) =>  console.log(req.body.name)) // <-- autocomplete

server.address("localhost", 3001)
	.listen()

Examples

See examples folder

waffle's People

Contributors

twoojoo avatar

Watchers

 avatar

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.