# @krknet/http-server

> Wrapper around Express

Latest version **2.3.0** (published 2024-06-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install @krknet/http-server
pnpm add @krknet/http-server
yarn add @krknet/http-server
bun add @krknet/http-server
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2024-06-01 |
| First published | 2020-12-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16 |
| Dependencies | 5 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 (+5 in 3 direct dependencies) |
| Install scripts | no |
| Author | KRK |
| Maintainers | krknet |

## Links

- npm: https://www.npmjs.com/package/@krknet/http-server
- Repository: https://git.krknet.de/krknet/packages/http-server
- Homepage: https://git.krknet.de/krknet/packages/http-server#readme
- npm.io page: https://npm.io/package/@krknet/http-server

## Dependencies (5)

- [helmet](https://npm.io/package/helmet.md) 7.1.0
- [morgan](https://npm.io/package/morgan.md) 1.10.0
- [express](https://npm.io/package/express.md) 4.19.2
- [stoppable](https://npm.io/package/stoppable.md) 1.1.0
- [body-parser](https://npm.io/package/body-parser.md) 1.20.2

## Recent versions

- 2.3.0 (latest) — 2024-06-01
- 2.2.0 — 2023-10-13
- 2.1.0 — 2023-09-07
- 2.0.0 — 2023-02-04
- 1.6.5 — 2023-02-04
- 1.6.4 — 2023-02-04
- 1.6.3 — 2022-08-24
- 1.6.2 — 2022-04-14
- 1.6.1 — 2022-04-13
- 1.6.0 — 2021-11-25
- 1.5.3 — 2021-07-06
- 1.5.2 — 2021-02-28
- 1.5.1 — 2021-02-15
- 1.5.0 — 2021-01-18
- 1.4.2 — 2021-01-17
- … 7 more at https://npm.io/package/@krknet/http-server/versions

## README

# HTTP-Server

Wrapper around Express

## Usage

```javascript
const HTTPserver = require('@krknet/http-server')
const httpServer = new HTTPserver({
  port: 8080,
  ApiRouter: require('./api'),
  PagesRouter: require('./frontend')
})

await httpServer.start()
await httpServer.stop()

const router = new HTTPserver.Router()
```

## Options

```javascript
{
  port: 8080, // Port - required
  host: '127.0.0.1', // Host - optional
  ApiRouter, // ApiRouter Class - required
  PagesRouter, // PagesRouter Class
  loadingPage: null, // Path to the Page Displayed during Initializing
  sentryRequests: null, // Sentry HTTP Request Handler
  onBeforeErrorHandlers: async () => null, // Sentry HTTP Request Handler
  sentryErrors: null, // Sentry HTTP Error Handler
  doTrustProxy: false, // enable('trust proxy')
  doLogAPI: false, // Morgen Request Logger for API Endpoints
  doLogFrontend: false, // Morgen Request Logger for Frontend Endpoints
  bodyParserOptions: {}, // Options for BodyParser
  helmetOptions: { contentSecurityPolicy: false }, // Options for Helmet
  onStart: async () => null, // Executed and waited for an Start
  initialMiddlewares: [], // Middlewares before all Parsers { route: '/', handler: (req, res, next) => next() },
  middlewares: [], // Middlewares { route: '/', handler: (req, res, next) => next() },
  statics: [] // Static Endpoints { route: '/static/', path: path.join(global.__basePath, 'static') }
}
```

## Functions

```javascript
async start ()

get rawServer ()

async stop ()
```

---
_Source: https://npm.io/package/@krknet/http-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._