https://github.com/assapir/yahf

Yet Another HTTP Framework, that you don't really need
https://github.com/assapir/yahf

Last synced: about 2 months ago
JSON representation

Yet Another HTTP Framework, that you don't really need

• Host: GitHub
• URL: https://github.com/assapir/yahf
• Owner: assapir
• License: mit
• Created: 2021-03-30T13:41:52.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-04-05T13:10:52.000Z (almost 4 years ago)
• Last Synced: 2024-04-25T06:01:51.223Z (9 months ago)
• Language: JavaScript
• Size: 26.4 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# YAHF

**Y**et **A**nother **H**TTP **F**ramework, that you don't really need

Trying to build a HTTP server framework, without using any external modules, because who needs npm?!

Everything is as I want it to be, not as one might used to.

[![Continuous Integration](https://github.com/assapir/yahf/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/assapir/yahf/actions/workflows/ci.yml)

## API

* Create new YAHF instance, with default options

  ```javascript

  import YAHF from 'yahf';

  const server = new YAHF();

  ```

* Options that can be passed to the `YAHF` constructor, as an object:

  * `logger`: `(str: string) => void`. Defaults to `console.log`.

  * `port`: `number`. Defaults to 1337.

* `useMiddleware(middleware: (data) => void)`.

  * Any result returned from this functions will be ignored.

  * Will be called in FIFO.

  * Return `this` so it can be chained.

example:

  ```javascript

  import YAHF from 'yahf';

  const server = new YAHF()

  server.useMiddleware((data) => {

      server.logger(data);

  })

  ```

* `addHandler(path:string | string[], handler`: `async data => RequestResult | undefined`.

  * Return `this` so it can be chained.

  * `RequestResult` is optional.

* `RequestResult`

  ```typescript

  {

      statusCode: number; // Defaults to 200

      contentType: string; // Defaults to 'application/json'

      payload: any;

  }

  ```

* `start()` : `Promise`

  * Will start the server, listening on the port was passed in.

  * Resolves to `this` so it can be chained.

* `kill()` : `Promise`

  * Will close the server.

  * Resolves to `this` so it can be chained.

* `logger` : `(str: string) => void`

  * Returns the passed in logger. will default to `console.log`

## Request lifecycle

* Every middleware/handler will get the following object:

  ```typescript

  {

    path: string;

    query: URLSearchParams;

    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'...;

    headers: object;

    payload: string; // Defaults to an empty string

  }

  ```

* Middlewares are called FIFO, and called before any handler.

* Handlers are called for exact match for the path, without starting `/`.