ForgeDocumentatie
nl

Documentatie

Van Express naar Total.js 5

Total.js 5 · total5@0.0.19 comparisonexpressmigration Uitgevoerd met Total.js 5

Total.js is niet Express onder een andere naam. De grootste verschillen: een handler krijgt één object, $, in plaats van (req, res); de body wordt door het framework geparsed op basis van het contenttype; je installeert geen pakketten voor cookies, uploads, validatie, sessies, CORS, cron of e-mail, omdat ze deel uitmaken van het framework; en de bestanden van je project worden uit mappen geladen in plaats van geïmporteerd (zie de pagina over de projectstructuur).

De tabellen koppelen gemeenschappelijke Express-patronen met hun Total.js 5 equivalenten.

TaakExpressTotal.js 5
De server startenapp.listen(3000)Total.run({ port: 3000 })
Een routeapp.get('/users', fn)ROUTE('GET /users/', fn) (schrijf de slash aan het einde)
Padparameterapp.get('/users/:id', fn) en req.params.idROUTE('GET /users/{id}/', fn) en $.params.id
Querystringreq.query.page$.query.page
JSON-bodyapp.use(express.json()) en req.body$.body, geparsed op basis van het contenttype
Request-headersreq.headers['x-token']$.headers['x-token']
JSON versturenres.json(object)$.json(object)
Tekst of HTML versturenres.send('text')$.plain('text') of $.html('<p>..</p>')
Statuscoderes.status(404).json(...)$.invalid(404) voor een fout, of $.response.status = 201 voor het antwoord
Response-headerres.set('x-a', 'b')$.response.headers['x-a'] = 'b'
Doorverwijzingres.redirect('/x')$.redirect('/x')
Cookiescookie-parser, res.cookie(...)$.cookie('name') om te lezen, $.cookie('name', value, '1 day') om te schrijven
Middleware op een routeapp.get('/a', mw, fn)MIDDLEWARE('mw', ($, next) => ...) en ROUTE('GET /a/ #mw', fn)
Statische bestandenapp.use(express.static('public'))Zet de bestanden in public/: geen code
Een bestand downloadenres.download(path, name)$.file(path, name)
Templateres.render('page', model)$.view('page', model)
Invoer validerenexpress-validator of zodinput: '*email:Email, age:Number' op een actie
Foutpaginaeen middleware voor foutafhandelingROUTE('#404', fn) en ROUTE('#401', fn)
Authenticatiepassport of express-sessionAUTH(fn) en ROUTE('+GET /private/', fn)
Uploadsmulterde flag @upload en $.files
CORScorsCORS('https://example.com')
Een andere API aanroepenaxios of fetchREQUEST() en RESTBuilder
Geplande takennode-cronCRON('0 9 * * 1-5', fn)
E-mail versturennodemailerMAIL() en HTMLMAIL() met mail_smtp in config
WebSocketws of socket.ioROUTE('SOCKET /chat/', fn)

Elk onderdeel heeft een recept met meer details; dit is de hele vertaling op één plek. Het voorbeeld hieronder is de Total.js-kant van de rijen die code nodig hebben.

definitions/compare.js
MIDDLEWARE('mw', function($, next) {
	$.response.headers['x-a'] = 'b';
	next();
});

NEWACTION('Users/create', {
	name: 'Create a user',
	input: '*email:Email, age:Number',
	action: function($, model) {
		$.callback({ email: model.email, age: model.age });
	}
});
controllers/compare.js
exports.install = function() {
	ROUTE('GET /users/{id}/', user);
	ROUTE('POST /users/ --> *Users/create');
	ROUTE('GET /mw/ #mw', ok);
	ROUTE('GET /created/', created);
	ROUTE('GET /moved/', moved);
	ROUTE('GET /cookie/', cookie);
	ROUTE('GET /html/', html);
};

function user($) {
	$.json({ id: $.params.id, page: $.query.page, token: $.headers['x-token'] });
}

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

function created($) {
	$.response.status = 201;
	$.json({ created: true });
}

function moved($) {
	$.redirect('/users/1/');
}

function cookie($) {
	$.cookie('visited', 'yes', '1 day');
	$.json({ before: $.cookie('visited') || null });
}

function html($) {
	$.html('<p>Hello</p>');
}