Type alias FastifyServerOptions<RawServer, Logger>

Type declaration

• Optional ajv?: {
      customOptions?: Options;
      plugins?: (Function | [Function, unknown])[];
  }

  • Optional customOptions?: Options

  • Optional plugins?: (Function | [Function, unknown])[]

• Optional allowUnsafeRegex?: boolean

• Optional bodyLimit?: number

• Optional caseSensitive?: boolean

• Optional clientErrorHandler?: ((error, socket) => void)

  listener to error events emitted by client connections

  • • (error, socket): void

    • Parameters

      • error: ConnectionError
      • socket: Socket

      Returns void

• Optional connectionTimeout?: number

• Optional constraints?: {
      [name: string]: ConstraintStrategy<FindMyWayVersion<RawServer>, unknown>;
  }

  • [name: string]: ConstraintStrategy<FindMyWayVersion<RawServer>, unknown>

• Optional disableRequestLogging?: boolean

• Optional exposeHeadRoutes?: boolean

• Optional forceCloseConnections?: boolean | "idle"

• Optional frameworkErrors?: (<RequestGeneric, TypeProvider, SchemaCompiler>(error, req, res) => void)

  • • <RequestGeneric, TypeProvider, SchemaCompiler>(error, req, res): void

    • Type Parameters

      • RequestGeneric extends RequestGenericInterface = RequestGenericInterface
      • TypeProvider extends FastifyTypeProvider = FastifyTypeProviderDefault
      • SchemaCompiler extends FastifySchema = FastifySchema

      Parameters

      • error: FastifyError
      • req: FastifyRequest<RequestGeneric, RawServer, RawRequestDefaultExpression<RawServer>, FastifySchema, TypeProvider>
      • res: FastifyReply<RawServer, RawRequestDefaultExpression<RawServer>, RawReplyDefaultExpression<RawServer>, RequestGeneric, FastifyContextConfig, SchemaCompiler, TypeProvider>

      Returns void

• Optional genReqId?: ((req) => string)

  • • (req): string

    • Parameters

      • req: RawRequestDefaultExpression<RawServer>

      Returns string

• Optional ignoreDuplicateSlashes?: boolean

• Optional ignoreTrailingSlash?: boolean

• Optional jsonShorthand?: boolean

• Optional keepAliveTimeout?: number

• Optional logger?: boolean | FastifyLoggerOptions<RawServer> & PinoLoggerOptions | Logger

• Optional maxParamLength?: number

• Optional maxRequestsPerSocket?: number

• Optional onConstructorPoisoning?: ConstructorAction

• Optional onProtoPoisoning?: ProtoAction

• Optional pluginTimeout?: number

• Optional querystringParser?: ((str) => {
      [key: string]: unknown;
  })

  • • (str): {
          [key: string]: unknown;
      }

    • Parameters

      • str: string

      Returns {
          [key: string]: unknown;
      }

      • [key: string]: unknown

• Optional requestIdHeader?: string | false

• Optional requestIdLogLabel?: string

• Optional requestTimeout?: number

• Optional return503OnClosing?: boolean

• Optional rewriteUrl?: ((this, req) => string)

  • • (this, req): string

    • Parameters

      • this: FastifyInstance<RawServer, RawRequestDefaultExpression<RawServer>, RawReplyDefaultExpression<RawServer>, Logger, FastifyTypeProviderDefault>
      • req: RawRequestDefaultExpression<RawServer>

      Returns string

• Optional schemaController?: {
      bucket?: ((parentSchemas?) => {
          add(schema): FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
          getSchema(schemaId): unknown;
          getSchemas(): Record<string, unknown>;
      });
      compilersFactory?: {
          buildSerializer?: SerializerFactory;
          buildValidator?: ValidatorFactory;
      };
  }

  • Optional bucket?: ((parentSchemas?) => {
        add(schema): FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
        getSchema(schemaId): unknown;
        getSchemas(): Record<string, unknown>;
    })

    • • (parentSchemas?): {
            add(schema): FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
            getSchema(schemaId): unknown;
            getSchemas(): Record<string, unknown>;
        }

      • Parameters

        • Optional parentSchemas: unknown

        Returns {
            add(schema): FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
            getSchema(schemaId): unknown;
            getSchemas(): Record<string, unknown>;
        }

        • add:function

          • add(schema): FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>

          • Parameters

            • schema: unknown

            Returns FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>

        • getSchema:function

          • getSchema(schemaId): unknown

          • Parameters

            • schemaId: string

            Returns unknown

        • getSchemas:function

          • getSchemas(): Record<string, unknown>

          • Returns Record<string, unknown>

  • Optional compilersFactory?: {
        buildSerializer?: SerializerFactory;
        buildValidator?: ValidatorFactory;
    }

    • Optional buildSerializer?: SerializerFactory

    • Optional buildValidator?: ValidatorFactory

• Optional schemaErrorFormatter?: SchemaErrorFormatter

• Optional serializerOpts?: Options | Record<string, unknown>

• Optional serverFactory?: FastifyServerFactory<RawServer>

• Optional trustProxy?: boolean | string | string[] | number | TrustProxyFunction

• Optional useSemicolonDelimiter?: boolean

• Optional versioning?: {
      deriveVersion<Context>(req, ctx?): string;
      storage(): {
          del(version): void;
          empty(): void;
          get(version): null | string;
          set(version, store): void;
      };
  }

  Deprecated

  Prefer using the constraints.version property

  • deriveVersion:function

    • deriveVersion<Context>(req, ctx?): string

    • Type Parameters

      • Context

      Parameters

      • req: Object
      • Optional ctx: Context

      Returns string

  • storage:function

    • storage(): {
          del(version): void;
          empty(): void;
          get(version): null | string;
          set(version, store): void;
      }

    • Returns {
          del(version): void;
          empty(): void;
          get(version): null | string;
          set(version, store): void;
      }

      • del:function

        • del(version): void

        • Parameters

          • version: string

          Returns void

      • empty:function

        • empty(): void

        • Returns void

      • get:function

        • get(version): null | string

        • Parameters

          • version: string

          Returns null | string

      • set:function

        • set(version, store): void

        • Parameters

          • version: string
          • store: Function

          Returns void