pogo

Server 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?
Usage
API
Contributing
License

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://deno.land/x/pogo/main.js';

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

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

app.start();

server = pogo.server(option)

Returns a server instance, which can then be used to add routes and start listening for requests.

option

Type: object

hostname

Type: string
Default: localhost

Specifies which domain or IP address the server will listen on when server.start() is called. Use 0.0.0.0 to listen on any hostname.

port

Type: number
Example: 3000

Specifies which port number the server will listen on when server.start() is called. Use 0 to listen on any available port.

server.route(option)

Adds a route to the server so that the server knows how to respond to requests for the given HTTP method and path, etc.

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 instance, which has utility methods for modifying the response.

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

Should return one of:

A string, which will be sent as HTML.
A JSON value, which will be sent as JSON using JSON.stringify().
A Response Toolkit instance, which will send the h.body() value, if any.

An appropriate Content-Type header will be set automatically based on the response body before the response is sent. You can use h.type() to override the default behavior.

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. When possible, it is 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.code(status.Teapot);
};