ArctonArcton
Referencia de la API

Arcton

La función factory que crea una instancia de aplicación

Toda aplicación Arcton comienza con una sola llamada a esta función:

import { Arcton } from '@arcton/core'

const app = Arcton()

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

app.listen()

Arcton()

Propósito: crea una nueva instancia de aplicación — un ArctonApp — sobre la que registras rutas, middleware y providers.

Firma

import type { ArctonApp, ArctonConfig } from '@arcton/core'

declare function Arcton(config?: ArctonConfig): ArctonApp<{}>

Parámetros

Propiedad

Tipo

Tipo de retorno: un ArctonApp<{}> sin contexto provisto todavía — provide() lo hace crecer a medida que registras providers.

Comportamiento: cada llamada a Arcton() crea una instancia independiente, con su propio árbol de rutas, middleware global y body parsers. Llamarla más de una vez — por ejemplo, para construir un module que luego se monta con app.use(module) — es la forma normal de componer una aplicación a partir de piezas más pequeñas.

Errores: ninguno directamente. Un config.prefix que no sea una ruta estática lanza una excepción en el momento de la construcción — ver ArctonConfig más abajo.

ArctonConfig

Propósito: el objeto de configuración que se pasa a Arcton().

Firma

interface ArctonConfig {
  prefix?: string
}

Parámetros

Propiedad

Tipo

Comportamiento: prefix debe ser una ruta estática — un segmento :param o *wildcard lanza una excepción al crear la instancia. '/' y un prefix omitido equivalen a no tener prefix. Ver Configuración de la app para la guía completa, incluyendo cómo se componen los prefixes entre modules montados.

Errores: un prefix no estático lanza Prefix "<value>" must be a static path — dynamic/wildcard segments aren't supported (e.g. app.use('/api', mw), not app.use('/api/:id', mw)). Ver Errores de registro.

Ejemplo

import { Arcton } from '@arcton/core'

const app = Arcton({ prefix: '/api' })

app.get('/users', () => [])

app.listen()

En esta página