Sintaxis de rutas de Total.js 5

Total.js 5 · total5@0.0.19 referenceroutingsyntax Ejecutada con Total.js 5

ROUTE(definition, handler) declara una ruta. La definición es un texto con estas partes, en este orden:

[+|-]METHOD /url/{param}/ [@flag ...] [#middleware ...] [<limit] [--> *Action ...]

Parte	Significado
`METHOD`	`GET`, `POST`, `PUT`, `PATCH`, `DELETE`, o `SOCKET` para un WebSocket y `FILE` para URLs con extensión: una URL como `/a.txt` nunca coincide con una ruta `GET`.
`+` o `-` antes del método	`+` acepta solo las peticiones que `AUTH()` aprobó, `-` solo las anónimas; cualquier otra petición recibe un 401. Sin prefijo la ruta es abierta.
`/url/`	La ruta. Escribe la barra final: las rutas se comparan con ella.
`{name}`	Un segmento de la ruta que se lee desde `$.params.name`.
`*` como último segmento	Coincide con cualquier ruta por debajo. Una ruta sin `*` es más específica y gana.
`@flag`	Una condición para la petición: `@json`, `@xml`, `@xhr`, `@upload`, `@debug`, `@release`, `@mobile`, `@robot`, `@referer` (o `@referrer`).
`#name`	Un middleware registrado con `MIDDLEWARE(name, fn)`.
`<limit`	`<10kb` limita el tamaño del cuerpo, `<30s` el tiempo de la petición.
`--> *Action`	Ejecuta una o más acciones con la entrada de la petición y responde con el resultado.
`#404`, `#401`...	Una ruta cuya definición es solo `#` y un código de estado reemplaza la página de error.

Una petición la atiende la primera ruta que coincide. Una petición que no cumple los flags de una ruta continúa a la siguiente y termina con un 404 cuando ninguna coincide; una petición que no cumple + o - recibe un 401. Una ruta sin flags en la misma URL siempre gana a una ruta con flags, así que nunca pongas ambas en una URL.

definitions/auth.js

AUTH(function($) {
	if ($.headers['x-token'] === 'secret')
		$.success({ id: '1' });
	else
		$.invalid();
});

MIDDLEWARE('stamp', function($, next) {
	$.response.headers['x-stamp'] = 'yes';
	next();
});

NEWACTION('Echo/one', { name: 'one', input: '*text:String', action: ($, model) => $.callback({ one: model.text }) });
NEWACTION('Echo/two', { name: 'two', action: ($, model) => $.callback({ two: true }) });

controllers/syntax.js

exports.install = function() {
	ROUTE('GET /plain/', plain);
	ROUTE('GET /users/{id}/', user);
	ROUTE('GET /files/*', files);
	ROUTE('POST /json/ @json', json);
	ROUTE('+GET /private/', plain);
	ROUTE('-GET /guest/', plain);
	ROUTE('GET /stamped/ #stamp', plain);
	ROUTE('POST /echo/ @json --> *Echo/one');
	ROUTE('FILE /robots-example.txt', file);
	ROUTE('#404', missing);
};

function plain($) {
	$.json({ ok: true });
}

function user($) {
	$.json({ id: $.params.id });
}

function files($) {
	$.json({ url: $.url });
}

function json($) {
	$.json({ body: $.body });
}

function file($) {
	$.plain('from a FILE route');
}

function missing($) {
	$.response.status = 404;
	$.plain('custom 404');
}