Interface Route

The base interface for all routes.

Route

Exports

Route

Example

import type { FastifyInstance } from "fastify";
import type { ROUTETYPE } from "./utils.js";
interface Route {
    DESCRIPTION?: string;
    ID: string;
    TYPE: ROUTETYPE;
    initialize(
        app: FastifyInstance<
            RawServerDefault,
            IncomingMessage,
            ServerResponse<IncomingMessage>,
            FastifyBaseLogger,
            FastifyTypeProviderDefault,
        >,
    ): Promise<void>;
}

Implemented by

Properties

DESCRIPTION? ID TYPE

Methods

initialize

Properties

OptionalDESCRIPTION

DESCRIPTION?: string

A description of the route.

ID

ID: string

The unique identifier for the route.

TYPE

TYPE: ROUTETYPE

The type of the route, defined by the ROUTETYPE enum.

Methods

initialize

  • initialize(
        app: FastifyInstance<
            RawServerDefault,
            IncomingMessage,
            ServerResponse<IncomingMessage>,
            FastifyBaseLogger,
            FastifyTypeProviderDefault,
        >,
    ): Promise<void>

  • Initializes the route.

    Parameters

    • app: FastifyInstance<
          RawServerDefault,
          IncomingMessage,
          ServerResponse<IncomingMessage>,
          FastifyBaseLogger,
          FastifyTypeProviderDefault,
      >

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods