ArctonArcton
Fundamentos

Aplicación

Crea una app de Arcton con `Arcton()` y descubre toda la superficie de una instancia de app.

Toda app de Arcton empieza igual — llama a Arcton() y obtienes un objeto sobre el que registras rutas y comportamiento:

import { Arcton } from '@arcton/core'

const app = Arcton()

app.get('/', () => ({ ok: true }))

app.listen()

Cada método de registro — get, post, use, provide, parser — devuelve la misma app, así que las llamadas se pueden encadenar:

import { Arcton } from '@arcton/core'

const app = Arcton()

app
  .use(async (ctx, next) => {
    console.log(ctx.request.method, new URL(ctx.request.url).pathname)
    await next()
  })
  .get('/health', () => ({ status: 'ok' }))

app.listen()

Poniendo un prefix a una instancia

Arcton() recibe un config opcional con un solo campo, prefix:

import { Arcton } from '@arcton/core'

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

api.get('/status', () => ({ ok: true }))

api.listen()

prefix se aplica a cada ruta y ruta ws registrada directamente en esa instancia — en este caso, GET /api/status. Tiene que ser una ruta estática (sin segmento :param ni *wildcard), y '/' se comporta igual que omitirlo. La misma instancia en la que configuras un prefix es también la que montas como module dentro de otra app — ver Modules.

La superficie de la app

MemberQué hace
configel objeto ArctonConfig que le pasaste a Arcton()
get / post / put / delete / patch / head / optionsregistra una ruta para ese método HTTP — ver Métodos HTTP
wsregistra una ruta de WebSocket — ver WebSockets
useagrega middleware global o con scope de ruta, o monta un module — ver Middleware y Modules
providecompone valores tipados sobre ctx — ver Providers
parserregistra un parser de body para un Content-Type — ver Parsers de Body
listenarranca el servidor — ver Opciones de listen

Cada método de ruta acepta un handler (con middleware opcional antes) o un objeto de opciones con esquemas de params / query / body — ver Descripción general de validación. Lo que pasa entre que llega un request y corre un handler es el tema de Ciclo de vida de la request.

En esta página