ForgeDokumentácia
sk

Dokumentácia

Z Express na Total.js 5

Total.js 5 · total5@0.0.19 comparisonexpressmigration Spustené s Total.js 5

Total.js nie je Express s iným názvom. Najväčšie rozdiely: obsluha dostáva jeden objekt $ namiesto (req, res); telo požiadavky spracuje framework podľa jeho typu obsahu; neinštalujete balíky pre cookies, nahrávanie, validáciu, relácie, CORS, cron ani e-mail, pretože sú súčasťou frameworku; a súbory projektu sa načítavajú z priečinkov namiesto importovania (pozrite stránku o štruktúre projektu).

Tabuľka páruje bežné expresné vzory s ich Total.js 5 ekvivalentov.

ÚlohaExpressTotal.js 5
Spustenie serveraapp.listen(3000)Total.run({ port: 3000 })
Routaapp.get('/users', fn)ROUTE('GET /users/', fn) (napíšte koncové lomítko)
Parameter cestyapp.get('/users/:id', fn) a req.params.idROUTE('GET /users/{id}/', fn) a $.params.id
Reťazec dotazureq.query.page$.query.page
Telo JSONapp.use(express.json()) a req.body$.body, spracované podľa typu obsahu
Hlavičky požiadavkyreq.headers['x-token']$.headers['x-token']
Odoslanie JSONres.json(object)$.json(object)
Odoslanie textu alebo HTMLres.send('text')$.plain('text') alebo $.html('<p>..</p>')
Stavový kódres.status(404).json(...)$.invalid(404) pre chybu, alebo $.response.status = 201 pred odpoveďou
Hlavička odpovederes.set('x-a', 'b')$.response.headers['x-a'] = 'b'
Presmerovanieres.redirect('/x')$.redirect('/x')
Cookiescookie-parser, res.cookie(...)$.cookie('name') na čítanie, $.cookie('name', value, '1 day') na zápis
Middleware na routeapp.get('/a', mw, fn)MIDDLEWARE('mw', ($, next) => ...) a ROUTE('GET /a/ #mw', fn)
Statické súboryapp.use(express.static('public'))Súbory dajte do public/: žiadny kód
Stiahnutie súborures.download(path, name)$.file(path, name)
Šablónares.render('page', model)$.view('page', model)
Validácia vstupuexpress-validator alebo zodinput: '*email:Email, age:Number' na akcii
Chybová stránkamiddleware na spracovanie chýbROUTE('#404', fn) a ROUTE('#401', fn)
Autentifikáciapassport alebo express-sessionAUTH(fn) a ROUTE('+GET /private/', fn)
Nahrávanie súborovmulterpríznak @upload a $.files
CORScorsCORS('https://example.com')
Volanie iného APIaxios alebo fetchREQUEST() a RESTBuilder
Naplánované úlohynode-cronCRON('0 9 * * 1-5', fn)
Odoslanie e-mailunodemailerMAIL() a HTMLMAIL() s mail_smtp v config
WebSocketws alebo socket.ioROUTE('SOCKET /chat/', fn)

Každá časť má recept s ďalšími podrobnosťami; toto je celé mapovanie na jednom mieste. Príklad nižšie je strana Total.js pre riadky, ktoré potrebujú kód.

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>');
}