ArctonArcton
Referencia de la API

listen()

Comienza a atender requests y devuelve un handle al servidor en ejecución

listen() es la última llamada en una aplicación Arcton:

import { Arcton } from '@arcton/core'

const app = Arcton()

app.get('/', () => 'Hello, Arcton!')

const server = app.listen({ port: 3000 })

console.log(`Listening on ${server.url}`)

Ver Opciones de listen para la guía orientada al uso.

listen

Propósito: inicia el servidor a través del adapter elegido.

Firma

import type { ArctonListenOptions } from '@arcton/core'
import type { RuntimeServer } from '@arcton/contracts'

declare function listen(options?: ArctonListenOptions): RuntimeServer

Parámetros: un ArctonListenOptions opcional, documentado más abajo.

Tipo de retorno: RuntimeServer.

Comportamiento: imprime un banner de arranque — el logo figlet de Arcton, la versión de Arcton, el nombre y versión del runtime, el env, y la URL de escucha — y luego devuelve un RuntimeServer. Las rutas, y las llamadas a use() y provide() hechas después de listen(), no afectan a las requests que ya fluyen a través de rutas registradas antes, ya que el pipeline de cada ruta queda fijado en un snapshot al momento del registro. A menos que gracefulShutdown sea false, también registra el servidor devuelto en un coordinador de apagado process-wide, para que una SIGTERM/SIGINT lo drene — ver Apagado elegante.

Errores: si se registró alguna ruta ws() y el capabilities.websocket del adapter elegido es false, listen() lanza Runtime "<adapter.name>" does not support WebSocket routes.. Ambos adapters incluidos — bunAdapter y nodeAdapter — soportan WebSockets, así que esto solo importa con un adapter personalizado. También lanza si shutdownTimeout se pasa pero no es un número positivo y finito.

ArctonListenOptions

Propósito: el objeto de opciones aceptado por listen().

Firma

import type { RuntimeAdapter } from '@arcton/contracts'

interface ArctonListenOptions {
  port?: number
  hostname?: string
  adapter?: RuntimeAdapter
  env?: string
  maxBodySize?: number
  gracefulShutdown?: boolean
  shutdownTimeout?: number
}

Parámetros

Propiedad

Tipo

Comportamiento: ver Entorno para lo que hace env (y solo eso), Tipos de runtime para la interfaz RuntimeAdapter, y Adapters para los valores bunAdapter/nodeAdapter.

gracefulShutdown y shutdownTimeout controlan el manejo process-wide de SIGTERM/SIGINT descrito en Apagado elegante. gracefulShutdown: false excluye por completo a una llamada de listen() dada — útil cuando la aplicación anfitriona maneja las señales del proceso por su cuenta, ya que un apagado elegante termina llamando a process.exit(), lo que termina todo el proceso, no solo este servidor.

RuntimeServer

Propósito: el handle que devuelve listen() para el servidor en ejecución.

Firma

interface RuntimeServer {
  readonly port: number
  readonly url: URL
  stop(closeActiveConnections?: boolean): void | Promise<void>
}

Parámetros

Propiedad

Tipo

Comportamiento: port y url reflejan la dirección realmente vinculada — útil cuando port: 0 eligió una libre. stop() apaga el servidor; devuelve void en el adapter de Bun y una Promise<void> en el adapter de Node. Este es el tipo que se usa en toda la sección de Testing para levantar un servidor en port: 0, ejercitarlo con llamadas fetch reales, y luego apagarlo.

Ejemplo

import { Arcton } from '@arcton/core'

const app = Arcton()

app.get('/', () => 'ok')

const server = app.listen({ port: 0 })

const res = await fetch(server.url)
console.log(res.status, server.port)

await server.stop()

En esta página