WineHorn

This is the main class through which the server is launched.

import WineHorn from "winehorn";

WineHorn(port?: number, routes?: Route[], config?: Config)

• port?: number - an optional argument that indicates on which port the server will be started.
• routes?: Route[] - an optional argument that accepts server routes.
• config?: Config - an optional argument that accepts configuration.

Methods

WineHorn.add()

The add method accepts and adds a new route to the server.

WineHorn.add(route: Route | RouteProto): void;

Using:

import WineHorn from "WineHorn";

let wh: WineHorn = new WineHorn();

wh.add(route);

WineHorn.listen()

The listen method starts the server.

WineHorn.listen(): void;

Using:

import WineHorn from "winehorn";

let wh: WineHorn = new WineHorn();

wh.listen();

WineHorn.use()

The use method accepts and writes to the $ register plugin.

WineHorn.use<T>(plugin: Plugin<T>): void;

Using:

import WineHorn from "winehorn";
import plugin from "my-plugin";

let wh: WineHorn = new WineHorn();

wh.use(plugin);

All plugins are written to the WineHorn.$ registry and can also be accessed through this registry, for example:

import WineHorn from "winehorn";
import plugin from "my-plugin"; // let's assume this plugin has a "hello" method

let wh: WineHorn = new WineHorn();

wh.use(plugin);

wh.$.myPlugin.hello();

WineHorn.middleware()

This method accepts and installs express middleware

WineHorn.middleware(middleware: RequestHandler): void;

import WineHorn from "winehorn";
import express from "express";

let wh: WineHorn = new WineHorn();

wh.middleware(express.json());