Route sintasi di Total.js 5

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

ROUTE(definition, handler) dichiara una route. La definizione è un testo con queste parti, in quest'ordine:

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

Parte	Significato
`METHOD`	`GET`, `POST`, `PUT`, `PATCH`, `DELETE`, oppure `SOCKET` per un WebSocket e `FILE` per URL con estensione: un URL come `/a.txt` non viene mai intercettato da una route `GET`.
`+` o `-` prima del metodo	`+` accetta solo le richieste che `AUTH()` ha approvato, `-` solo quelle anonime; ogni altra richiesta riceve un 401. Senza prefisso la route è aperta.
`/url/`	Il percorso. Scrivi la barra finale: le route vengono confrontate con essa.
`{name}`	Un segmento del percorso che si legge da `$.params.name`.
`*` come ultimo segmento	Corrisponde a qualsiasi percorso sottostante. Una route senza `*` è più specifica e vince.
`@flag`	Una condizione per la richiesta: `@json`, `@xml`, `@xhr`, `@upload`, `@debug`, `@release`, `@mobile`, `@robot`, `@referer` (o `@referrer`).
`#name`	Un middleware registrato con `MIDDLEWARE(name, fn)`.
`<limit`	`<10kb` limita la dimensione del corpo, `<30s` la durata della richiesta.
`--> *Action`	Esegue una o più azioni con l'input della richiesta e risponde con il risultato.
`#404`, `#401`...	Una route la cui definizione è solo `#` e un codice di stato sostituisce la pagina di errore.

Una richiesta è gestita dalla prima route corrispondente. Una richiesta che non soddisfa i flag di una route passa alla successiva e termina con un 404 se nessuna corrisponde; una richiesta che non soddisfa + o - riceve un 401. Una route senza flag sullo stesso URL vince sempre su una route con flag, quindi non mettere mai entrambe su un 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');
}