server.js Node.js Framework

Common errors

• TypeError: ctx.status(...).send is not a function

  cause Attempting to send an empty body by just setting the status code, which was a behavior change in version 1.0.12.
  fix Explicitly call `.send()` after `.status(NUMBER)`, e.g., `ctx.status(200).send()`.

• Error: No response from the server

  cause This error or similar warnings (like 'No response was sent from the server') can occur if a route handler does not explicitly return a value or call a response method (e.g., `ctx.send()`, `ctx.render()`, `ctx.redirect()`). Improved error handling for this was added in 1.0.9 and 1.0.13.
  fix Ensure all route handlers either return a value (which `server` then sends as the response) or explicitly call a response method on the `ctx` object.

• Inconsistent routing with '*' wildcard using Yarn

  cause Prior to version 1.0.7, there were known issues where wildcard routes (e.g., `get('*', ...)`) behaved differently when `server` was installed via Yarn compared to npm due to `path-to-regexp-wrap` resolution.
  fix Upgrade `server` to version 1.0.7 or higher. If upgrading is not an option, consider using npm instead of Yarn, or avoid wildcard routes in affected versions.

Warnings

• gotcha The package officially supports Node.js versions >=7.6.0 and recommends 8.x.y LTS. While it might run on newer Node.js versions, compatibility beyond Node 8.x LTS is not explicitly guaranteed in the documentation, which could lead to unexpected behavior.
  Fix: Ensure your Node.js environment is within the recommended range or thoroughly test on newer versions for full compatibility.
• breaking As of version 1.0.12, sending only a status code no longer automatically sets a default body (which was previously handled by Express). To send an empty body with a status, you must explicitly call `.send()` after `.status(NUMBER)`.
  Fix: Update your response handling from `ctx.status(200)` to `ctx.status(200).send()` when no body is intended.
• gotcha The package primarily uses CommonJS `require()` syntax in all documentation and examples. While Node.js supports ESM, `server` does not explicitly document or guarantee full ESM compatibility. Attempting to use `import` statements might lead to module resolution errors or unexpected behavior.
  Fix: Adhere to CommonJS `require()` syntax for importing modules and functions from `server`.
• gotcha Prior to version 1.0.7, there were inconsistent path resolution issues when using Yarn (compared to npm) with wildcard routes, specifically affecting `path-to-regexp-wrap` behavior.
  Fix: Upgrade to `server` version 1.0.7 or newer to resolve `path-to-regexp-wrap` inconsistencies with Yarn.

Install

• npm install server npm
• yarn add server yarn
• pnpm add server pnpm

Imports

• server

  const server = require('server');

  The primary export is a function to start the server. This package is primarily CommonJS-based.
• get, post
  wrong:

  import { get, post } from 'server/router';

  correct:

  const { get, post } = require('server').router;

  Router methods like `get`, `post`, `put`, `del`, `socket` are available via `server.router` or direct import from `server/router`. ESM imports are not officially supported in the 1.x series.
• render, redirect
  wrong:

  import { render, redirect } from 'server/reply';

  correct:

  const { render, redirect } = require('server').reply;

  Reply helper functions for rendering templates or redirecting are found on `server.reply`. ESM imports are not officially supported in the 1.x series.

Quickstart

This quickstart code initializes a server listening on port 8080 with a GET route responding 'Hello world' and a POST route logging request data.

const server = require('server');
const { get, post } = server.router;

// Launch server with options and a couple of routes
server({ port: 8080 }, [
  get('/', ctx => 'Hello world'),
  post('/', ctx => {
    console.log(ctx.data);
    return 'ok';
  })
]);