ForgeDokumentace
cs

Dokumentace

Z Express na Total.js 5

Total.js 5 · total5@0.0.19 comparisonexpressmigration Spuštěno s Total.js 5

Total.js není Express s jiným názvem. Největší rozdíly: obsluha dostává jeden objekt $ místo (req, res); tělo požadavku zpracuje framework podle jeho typu obsahu; neinstalujete balíčky pro cookies, nahrávání, validaci, relace, CORS, cron ani e-mail, protože jsou součástí frameworku; a soubory projektu se načítají ze složek místo importování (viz stránka o struktuře projektu).

Tabulka páří společné expresní vzory s jejich Total.js 5 ekvivalentů.

ÚlohaExpressTotal.js 5
Spuštění serveruapp.listen(3000)Total.run({ port: 3000 })
Routaapp.get('/users', fn)ROUTE('GET /users/', fn) (napište koncové lomítko)
Parametr cestyapp.get('/users/:id', fn) a req.params.idROUTE('GET /users/{id}/', fn) a $.params.id
Řetězec dotazureq.query.page$.query.page
Tělo JSONapp.use(express.json()) a req.body$.body, zpracováno podle typu obsahu
Hlavičky požadavkureq.headers['x-token']$.headers['x-token']
Odeslání JSONres.json(object)$.json(object)
Odeslání textu nebo HTMLres.send('text')$.plain('text') nebo $.html('<p>..</p>')
Stavový kódres.status(404).json(...)$.invalid(404) pro chybu, nebo $.response.status = 201 před odpovědí
Hlavička odpovědires.set('x-a', 'b')$.response.headers['x-a'] = 'b'
Přesměrováníres.redirect('/x')$.redirect('/x')
Cookiescookie-parser, res.cookie(...)$.cookie('name') pro čtení, $.cookie('name', value, '1 day') pro zápis
Middleware na routeapp.get('/a', mw, fn)MIDDLEWARE('mw', ($, next) => ...) a ROUTE('GET /a/ #mw', fn)
Statické souboryapp.use(express.static('public'))Soubory dejte do public/: žádný kód
Stažení souborures.download(path, name)$.file(path, name)
Šablonares.render('page', model)$.view('page', model)
Validace vstupuexpress-validator nebo zodinput: '*email:Email, age:Number' na akci
Chybová stránkamiddleware pro zpracování chybROUTE('#404', fn) a ROUTE('#401', fn)
Autentizacepassport nebo express-sessionAUTH(fn) a ROUTE('+GET /private/', fn)
Nahrávání souborůmulterpříznak @upload a $.files
CORScorsCORS('https://example.com')
Volání jiného APIaxios nebo fetchREQUEST() a RESTBuilder
Plánované úlohynode-cronCRON('0 9 * * 1-5', fn)
Odeslání e-mailunodemailerMAIL() a HTMLMAIL() s mail_smtp v config
WebSocketws nebo socket.ioROUTE('SOCKET /chat/', fn)

Každá část má recept s dalšími podrobnostmi; toto je celé mapování na jednom místě. Příklad níže je strana Total.js řádků, které potřebují 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>');
}