ForgeDokumentacja
pl

Dokumentacja

Z Express do Total.js 5

Total.js 5 · total5@0.0.19 comparisonexpressmigration Uruchomiono z Total.js 5

Total.js to nie Express pod inną nazwą. Największe różnice: obsługa otrzymuje jeden obiekt $ zamiast (req, res); treść żądania parsuje framework na podstawie typu zawartości; nie instalujesz pakietów do ciasteczek, przesyłania plików, walidacji, sesji, CORS, cron ani poczty, bo są częścią frameworka; a pliki projektu są ładowane z folderów zamiast importowane (zobacz stronę o strukturze projektu).

Tabela pary wspólnych wzorów Express z ich równania Total.js 5.

ZadanieExpressTotal.js 5
Uruchomienie serweraapp.listen(3000)Total.run({ port: 3000 })
Trasaapp.get('/users', fn)ROUTE('GET /users/', fn) (napisz końcowy ukośnik)
Parametr ścieżkiapp.get('/users/:id', fn) i req.params.idROUTE('GET /users/{id}/', fn) i $.params.id
Ciąg zapytaniareq.query.page$.query.page
Treść JSONapp.use(express.json()) i req.body$.body, parsowane według typu zawartości
Nagłówki żądaniareq.headers['x-token']$.headers['x-token']
Wysłanie JSONres.json(object)$.json(object)
Wysłanie tekstu lub HTMLres.send('text')$.plain('text') lub $.html('<p>..</p>')
Kod statusures.status(404).json(...)$.invalid(404) dla błędu, lub $.response.status = 201 przed odpowiedzią
Nagłówek odpowiedzires.set('x-a', 'b')$.response.headers['x-a'] = 'b'
Przekierowanieres.redirect('/x')$.redirect('/x')
Ciasteczkacookie-parser, res.cookie(...)$.cookie('name') do odczytu, $.cookie('name', value, '1 day') do zapisu
Middleware na trasieapp.get('/a', mw, fn)MIDDLEWARE('mw', ($, next) => ...) i ROUTE('GET /a/ #mw', fn)
Pliki statyczneapp.use(express.static('public'))Umieść pliki w public/: bez kodu
Pobranie plikures.download(path, name)$.file(path, name)
Szablonres.render('page', model)$.view('page', model)
Walidacja wejściaexpress-validator lub zodinput: '*email:Email, age:Number' na akcji
Strona błędumiddleware obsługi błędówROUTE('#404', fn) i ROUTE('#401', fn)
Uwierzytelnianiepassport lub express-sessionAUTH(fn) i ROUTE('+GET /private/', fn)
Przesyłanie plikówmulterflaga @upload i $.files
CORScorsCORS('https://example.com')
Wywołanie innego APIaxios lub fetchREQUEST() i RESTBuilder
Zadania cyklicznenode-cronCRON('0 9 * * 1-5', fn)
Wysyłanie pocztynodemailerMAIL() i HTMLMAIL() z mail_smtp w config
WebSocketws lub socket.ioROUTE('SOCKET /chat/', fn)

Każda część ma przepis z większą liczbą szczegółów; to całe odwzorowanie w jednym miejscu. Poniższy przykład to strona Total.js wierszy, które wymagają kodu.

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