Skip to content

ServerOptions ​

ServerOptions configura o listener passado para app.listen(...). Passe as opções como objeto, diretamente na chamada ou por meio de um valor tipado como ServerOptions.

Assinaturainterface ServerOptions

Configurações ​

ConfiguraçãoFinalidade
hostEndereço IP para associação. O padrão é todas as interfaces.
requestTimeoutTempo máximo de uma requisição, incluindo corpo e handler. Requisições que excedem o limite recebem 503.
maxConcurrentRequestsNúmero máximo de requisições em execução ao mesmo tempo. As demais aguardam uma vaga e continuam limitadas por requestTimeout.
maxConnectionsNúmero máximo de conexões abertas. Vem sem limite por padrão; ao atingir o valor, o servidor para de aceitar conexões.
shutdownTimeoutTempo máximo para aguardar requisições ativas durante o encerramento.
loggerCom true, escreve um evento estruturado de acesso por resposta concluída em stderr; o padrão é false.
headerTimeoutTempo máximo para receber os cabeçalhos da requisição. O padrão é 10 segundos e não pode ser desativado.
maxHeaderSizeTamanho máximo combinado da linha da requisição e dos cabeçalhos. O padrão é 64 KiB e o mínimo é 8 KiB.
keepAlivePermite que uma conexão carregue várias requisições. Vem ativado por padrão.
tlsServe HTTPS com o certificado e a chave privada configurados. Ambos são obrigatórios.

rateLimit é configurado no roteador com app.rateLimit(...), e não em ServerOptions. Os limites de cabeçalhos se aplicam antes da execução de uma rota, enquanto requestTimeout cobre a requisição depois da chegada dos cabeçalhos.

Exemplo ​

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}`);
}