pogo

Web framework for Deno

Pogo is an easy to use, safe, and expressive framework for writing web servers and applications. It is inspired by hapi.

Why?

Designed to encourage reliable and testable applications.
Routes are simple, pure functions that return values directly.
Automatic JSON responses from objects.

Usage

import pogo from 'https://denopkg.com/sholladay/pogo@v0.1.0/main.js';

const app = pogo.server({ port : 3000 });

app.route({
    method : 'GET',
    path   : '/hello',
    handler() {
        return 'Hello, world!';
    }
});

app.start();

Note: This project is experimental. It works as documented, but the API is limited. Issues and PRs are welcome!

API

server = pogo.server(option)

Returns a server instance, which can be used to add routes and

option

Type: object

hostname

Type: string
Default: localhost

Specifies which domain or IP address to listen on. Use 0.0.0.0 to listen on any hostname.

port

Type: number
Example: 3000

Specifies which port number to listen on.

server.route(option)

Adds a route to the server so that the server knows how to respond to requests for the given route.

option

Type: object

method

Type: string
Example: GET

Any valid HTTP method. Used to limit which requests will trigger the route handler.

path

Type: string
Example: /

Any valid URL path. used to limit which requests will trigger the route handler.

handler(request, h)

Type: function

request is a ServerRequest instance with properties for headers, method, url, and more.
h is a response toolkit with methods

The implementation for the route that handles requests. Called when a request is received that matches the method and path specified in the route configuration.

Should return a string or object. Strings are sent as HTML, objects are sent as JSON (using JSON.stringify()). In either case, an appropriate Content-Type header will be sent.

server.start()

Begins listening on the hostname and port specified when the server was created.

Response Toolkit

The response toolkit is an object that is passed to route handlers, with utility methods that make it easy to modify the response. For example, you can use it to set headers or a status code.

By convention, this object is assigned to a variable named h in code examples.

h.body(body)

Sets the response body. This is the same as returning the body directly from the route handler, but it’s useful in order to begin a chain with other toolkit methods.

h.code(statusCode)

Sets the response status code. Whenever possible, it would be better to use a more specific method instead, such as h.redirect().

Tip: Use Deno’s status constants to define the status code.

import { Status as status } from 'https://deno.land/x/http/http_status.ts';
const handler = (request, h) => {
    return h.status(status.Teapot);
};