# @jakecyr/simple-node-server

> Simple and slim Node.js HTTP server

Latest version **1.0.6** (published 2019-12-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install @jakecyr/simple-node-server
pnpm add @jakecyr/simple-node-server
yarn add @jakecyr/simple-node-server
bun add @jakecyr/simple-node-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 | 1.0.6 |
| Published | 2019-12-18 |
| First published | 2019-12-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 32 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jake Cyr |
| Maintainers | jakecyr |
| Keywords | http-server, slim framework, framework |

## Links

- npm: https://www.npmjs.com/package/@jakecyr/simple-node-server
- Repository: https://github.com/jakecyr/simple-nodejs-server
- Homepage: https://github.com/jakecyr/simple-nodejs-server#readme
- Issues: https://github.com/jakecyr/simple-nodejs-server/issues
- npm.io page: https://npm.io/package/@jakecyr/simple-node-server

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2019-12-18
- 1.0.5 — 2019-12-18
- 1.0.4 — 2019-12-18
- 1.0.3 — 2019-12-18
- 1.0.2 — 2019-12-18
- 1.0.1 — 2019-12-18
- 1.0.0 — 2019-12-18

## README

# Simple Node.js HTTP Server

## Installation

* Install the npm package `npm install @jakecyr/simple-node-server`
* Import the module to your project (see example below)

## Usage

After installing installing the framework, create a new instance of `Simple` and start creating your server:

```javascript
// import simple framework
const Simple = require('@jakecyr/simple-node-server');

// create new simple server with logging
let app = new Simple(true);

app
    .get('/', (req, res) => {
        res.end('nothing here yet');
    })
    .get('/some-json', (req, res) => {
        res.json({ task: 'Task 1' });
    })
    .listen(8080, '0.0.0.0', () => {
        console.log('Listening');
    });
```

### Middleware

* All request types support middleware functions
* The last function must end the response
* All route handler functions are executed in the order they are specified

Example:
```javascript
function log(req, res, next) {
    console.log('LOG VISIT', req.url);
    next();
}

// add middleware to log page url visited to server console
app.get('/', log, (req, res) => {
    res.end('Visit has been logged');
});
```

### Query Parameters

Parse query parameters as needed using the `request` object in a handler function. Example:

```javascript
app.get('/echo-name', (req, res) => {
    const queryParams = req.query();
    res.end(queryParams.name);
})
```

### Body Parsing

Parse a payload body as needed using the `request` object in a handler function. Example:

```javascript
app.post('/', async (req, res) => {
    // wait for all payload data to parse
    const payload = await req.body();

    // echo back the payload to the client
    res.json(payload);
})
```

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