Skip to content

ServerOptions ​

ServerOptions configura el listener que se pasa a app.listen(...). Pase las opciones como objeto, directamente en la llamada o mediante un valor tipado como ServerOptions.

Firmainterface ServerOptions

Opciones ​

OpciónFinalidad
hostDirección IP a la que asociarse. De forma predeterminada, todas las interfaces.
requestTimeoutTiempo máximo de una petición, incluido el cuerpo y el handler. Las peticiones que exceden el límite reciben 503.
maxConcurrentRequestsNúmero máximo de peticiones ejecutándose a la vez. Las demás esperan un permiso y siguen limitadas por requestTimeout.
maxConnectionsNúmero máximo de conexiones abiertas. No tiene límite por defecto; al alcanzar el valor, el servidor deja de aceptar conexiones.
shutdownTimeoutTiempo máximo para esperar las peticiones activas durante el cierre.
loggerCon true, escribe un evento estructurado de acceso por respuesta completada en stderr; el valor predeterminado es false.
headerTimeoutTiempo máximo para recibir las cabeceras de la petición. El valor predeterminado es 10 segundos y no se puede desactivar.
maxHeaderSizeTamaño máximo combinado de la línea de petición y las cabeceras. El valor predeterminado es 64 KiB y el mínimo es 8 KiB.
keepAlivePermite que una conexión lleve varias peticiones. Está activado de forma predeterminada.
tlsSirve HTTPS con el certificado y la clave privada configurados. Ambos son obligatorios.

rateLimit se configura en el router con app.rateLimit(...), no en ServerOptions. Los límites de cabeceras se aplican antes de ejecutar una ruta, mientras que requestTimeout cubre la petición después de recibir las cabeceras.

Ejemplo ​

tyrus
import { createRouter, HttpError, HttpRouter, ServerOptions } from "tyrus:http";

const app: HttpRouter = createRouter();
const options: ServerOptions = {
    host: "127.0.0.1",
    requestTimeout: "30s",
    maxConcurrentRequests: 1024,
    maxConnections: 4096,
    shutdownTimeout: "10s",
    logger: true,
};

try {
    app.listen(3000, options);
} catch (error: HttpError) {
    printError(`${error.code}: ${error.message}`);
}