Van Express naar 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.
| Taak | Express | Total.js 5 |
|---|---|---|
| De server starten | app.listen(3000) | Total.run({ port: 3000 }) |
| Een route | app.get('/users', fn) | ROUTE('GET /users/', fn) (schrijf de slash aan het einde) |
| Padparameter | app.get('/users/:id', fn) en req.params.id | ROUTE('GET /users/{id}/', fn) en $.params.id |
| Querystring | req.query.page | $.query.page |
| JSON-body | app.use(express.json()) en req.body | $.body, geparsed op basis van het contenttype |
| Request-headers | req.headers['x-token'] | $.headers['x-token'] |
| JSON versturen | res.json(object) | $.json(object) |
| Tekst of HTML versturen | res.send('text') | $.plain('text') of $.html('<p>..</p>') |
| Statuscode | res.status(404).json(...) | $.invalid(404) voor een fout, of $.response.status = 201 voor het antwoord |
| Response-header | res.set('x-a', 'b') | $.response.headers['x-a'] = 'b' |
| Doorverwijzing | res.redirect('/x') | $.redirect('/x') |
| Cookies | cookie-parser, res.cookie(...) | $.cookie('name') om te lezen, $.cookie('name', value, '1 day') om te schrijven |
| Middleware op een route | app.get('/a', mw, fn) | MIDDLEWARE('mw', ($, next) => ...) en ROUTE('GET /a/ #mw', fn) |
| Statische bestanden | app.use(express.static('public')) | Zet de bestanden in public/: geen code |
| Een bestand downloaden | res.download(path, name) | $.file(path, name) |
| Template | res.render('page', model) | $.view('page', model) |
| Invoer valideren | express-validator of zod | input: '*email:Email, age:Number' op een actie |
| Foutpagina | een middleware voor foutafhandeling | ROUTE('#404', fn) en ROUTE('#401', fn) |
| Authenticatie | passport of express-session | AUTH(fn) en ROUTE('+GET /private/', fn) |
| Uploads | multer | de flag @upload en $.files |
| CORS | cors | CORS('https://example.com') |
| Een andere API aanroepen | axios of fetch | REQUEST() en RESTBuilder |
| Geplande taken | node-cron | CRON('0 9 * * 1-5', fn) |
| E-mail versturen | nodemailer | MAIL() en HTMLMAIL() met mail_smtp in config |
| WebSocket | ws of socket.io | ROUTE('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.
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 });
}
});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>');
}