Super Simple Fastify Server

Common errors

• Error: Cannot find module 'fastify' from '<path_to_your_project>'

  cause `fastify` peer dependency is not installed.
  fix Install Fastify: `npm install fastify`

• Error: listen EADDRINUSE: address already in use :::3456

  cause Another process is already using the configured port (default is 3456).
  fix Change the `port` option in the `SimpleFastifyServer` constructor or set the `SIMPLE_FASTIFY_SERVER_PORT` environment variable to an available port.

• TypeError: (0, _super_simple_fastify_server__WEBPACK_IMPORTED_MODULE_0__.SimpleFastifyServer) is not a constructor

  cause Attempting to import `SimpleFastifyServer` as a default export when it is a named export.
  fix Use a named import: `import { SimpleFastifyServer } from 'super-simple-fastify-server';`

Warnings

• gotcha This library lists `fastify` and `pino-pretty` as peer dependencies. You must install them separately alongside `super-simple-fastify-server` for the server to function correctly.
  Fix: Ensure you install the peer dependencies: `npm install fastify pino-pretty` (or `--save-dev` if used as a dev dependency).
• gotcha Configuration options (host, port) passed to the `SimpleFastifyServer` constructor can be overridden by environment variables (`SIMPLE_FASTIFY_SERVER_HOST`, `SIMPLE_FASTIFY_SERVER_PORT`) if not explicitly provided, which might lead to unexpected server addresses or ports.
  Fix: Always explicitly pass `host` and `port` options to the constructor if you require specific values, or ensure that relevant environment variables are set or unset as desired.
• gotcha This package is explicitly designed for 'rapid dev/test' and does not implement production-grade security, performance optimizations, or robust error handling expected in public-facing applications.
  Fix: For production deployments, consider a fully configured Fastify application with appropriate plugins for security, logging, metrics, and error handling.

Install

• npm install super-simple-fastify-server npm
• yarn add super-simple-fastify-server yarn
• pnpm add super-simple-fastify-server pnpm

Imports

• SimpleFastifyServer
  wrong:

  import SimpleFastifyServer from 'super-simple-fastify-server';

  correct:

  import { SimpleFastifyServer } from 'super-simple-fastify-server';

  This is a named export. Attempting to import it as a default export will result in a TypeError.
• FastifyInstance
  wrong:

  import { FastifyInstance } from 'fastify';

  correct:

  import { FastifyInstance } from 'super-simple-fastify-server';

  The `FastifyInstance` type definition is re-exported from `super-simple-fastify-server` for convenience, although its origin is the `fastify` package itself.
• buildObjectStreamResponse
  wrong:

  const { buildObjectStreamResponse } = require('super-simple-fastify-server');

  correct:

  import { buildObjectStreamResponse } from 'super-simple-fastify-server';

  A named export utility for constructing streamable JSON responses. The package is primarily designed for ESM usage.

Quickstart

This quickstart demonstrates how to initialize `SimpleFastifyServer`, define a basic GET route, and start the server on a specified host and port.

import { FastifyInstance, SimpleFastifyServer } from 'super-simple-fastify-server';

const server = new SimpleFastifyServer(
    async (app: FastifyInstance) => {
        app.get('/hello-world', async (request, _reply) => {
            return { message: `Hello, ${request.query.target}!` };
        });
    },
    {
        host: '127.0.0.1',
        port: 3456
    }
);

(async () => {
  await server.start();
  console.log(`Server listening at http://${server.config.host}:${server.config.port}`);
  // To stop the server later:
  // await server.stop();
})();