# Objekt $ pre obchodníka Total.js 5

> Použite vlastnosti a metódy ovládača, ktoré dostane obchodník s trasami.

Framework: total5
Product: Total.js 5 (total5@0.0.19)
Language: sk
Content-SHA256: 2240e53de4efaa32c1234d757f5ca8343e47037bf227195db86846d61b1d008d
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: total5-installed@total5@0.0.19
Review: not-recorded

Obsluha routy dostáva jeden objekt, na tomto webe zapísaný ako `$`. Popisuje požiadavku a odpovedá na ňu. Odpovedajte **iba raz**: po `$.json()`, `$.html()` alebo inej odpovedi je požiadavka dokončená.

## Vlastnosti

| Vlastnosť | Typ | Čo to je |
|---|---|---|
| `$.url` | string | Cesta požiadavky bez reťazca dotazu. |
| `$.method` | string | `GET`, `POST`... |
| `$.query` | object | Reťazec dotazu, spracovaný. |
| `$.params` | object | Segmenty `{name}` routy. |
| `$.body` | object | Telo spracované podľa typu obsahu (JSON, formulár URL-encoded, XML alebo polia multipart). |
| `$.files` | array | Nahrané súbory požiadavky multipart. |
| `$.headers` | object | Hlavičky požiadavky s názvami malými písmenami. |
| `$.ip` | string | IP adresa; prvá adresa z `x-forwarded-for`, keď hlavička existuje. |
| `$.host` | string | Hlavička `host`. |
| `$.referrer` | string | Hlavička `referer`. |
| `$.protocol` | string | `http` alebo `https` (aj vtedy, keď to proxy uvádza v `x-forwarded-proto`). |
| `$.ext` | string | Prípona URL bez bodky (`$.extension` je to isté). |
| `$.xhr` | boolean | `true`, keď je hlavička `x-requested-with` rovná `XMLHttpRequest`. |
| `$.mobile` | boolean | `true`, keď user agent vyzerá ako mobilný prehliadač. |
| `$.robot` | boolean | `true`, keď user agent vyzerá ako crawler. |
| `$.ua` | string | Krátky názov prehliadača a systému, napríklad `iPhone Safari` alebo `Windows Chrome`. |
| `$.user` | object | Používateľ, ktorého schválil `AUTH()`, alebo nič. |
| `$.language` | string | Jazyk, ktorý vybral `LOCALIZE()`. |
| `$.datatype` | string | `json`, `urlencoded`, `multipart`, `xml`, `text` alebo `binary`: typ tela požiadavky. |
| `$.response` | object | Čo sa odošle: `status`, `headers` a `value`. Pred odpoveďou zmeňte `$.response.status` a `$.response.headers`. |
| `$.req`, `$.res` | objects | Požiadavka a odpoveď Node.js. |

## Metódy, ktoré odpovedajú

| Metóda | Čo robí | Recept |
|---|---|---|
| `$.json(value)` | Odpovie JSON. | [responses](/en/total5/responses/) |
| `$.jsonstring(text)` | Odpovie textom, ktorý už je JSON, bez opätovnej serializácie. | [controller-completion-and-cache](/en/total5/controller-completion-and-cache/) |
| `$.html(text)` | Odpovie HTML. | [responses](/en/total5/responses/) |
| `$.plain(text)` | Odpovie čistým textom (`$.text` je to isté). | [responses](/en/total5/responses/) |
| `$.xml(text)` | Odpovie XML. | [responses](/en/total5/responses/) |
| `$.empty()` | Odpovie stavom 204 a bez tela. | [responses](/en/total5/responses/) |
| `$.redirect(url, permanent)` | Presmeruje (302, alebo 301, keď je `permanent` true). | [responses](/en/total5/responses/) |
| `$.binary(buffer, type, name)` | Odpovie bajtmi a typom obsahu. | [responses](/en/total5/responses/) |
| `$.file(path, name)` | Odošle súbor z disku. | [file-download](/en/total5/file-download/) |
| `$.stream(type, stream, name)` | Odošle čitateľný stream. | [file-download](/en/total5/file-download/) |
| `$.filefs(storage, id)` | Odošle súbor z `FILESTORAGE`. | [filestorage](/en/total5/filestorage/) |
| `$.image(options)` | Vytvorí a odošle obrázok na požiadanie. | [images](/en/total5/images/) |
| `$.view(name, model)` | Vykreslí pohľad s layoutom a odpovie ním. | [views-and-layouts](/en/total5/views-and-layouts/) |
| `$.layout(name)` | Vyberie iný layout pre nasledujúce `$.view()`. | [view-sections](/en/total5/view-sections/) |
| `$.proxy(url)` | Presmeruje požiadavku na inú URL a odpovie jej odpoveďou. | [proxy](/en/total5/proxy/) |
| `$.respond(value)` | Odpovie vo formáte `$.response.output` (`json`, keď nie je nastavený). | [controller-completion-and-cache](/en/total5/controller-completion-and-cache/) |
| `$.invalid(value)` | Odpovie chybou: textom, stavovým kódom ako `404` alebo `ErrorBuilder`. | [actions-crud](/en/total5/actions-crud/) |
| `$.fallback(code)` | Odpovie stránkou chybového kódu, vlastnou, keď existuje `ROUTE('#404')`. | [error-pages](/en/total5/error-pages/) |
| `$.success(value)` | Odpovie `{ "success": true }`; `value` sa k nemu pridá. | [responses](/en/total5/responses/) |
| `$.callback(err, value)` | Pri chybe odpovie `$.invalid(err)`, inak `$.json(value)` alebo `$.success()`, keď je `value` `undefined`. Bez argumentov vráti funkciu `(err, response)`, ktorá robí to isté. | [actions-crud](/en/total5/actions-crud/) |
| `$.successful(fn)` | Vráti funkciu `(err, a, b, c)`: pri chybe odpovie `$.invalid(err)`, inak zavolá `fn(a, b, c)`. | [controller-completion-and-cache](/en/total5/controller-completion-and-cache/) |
| `$.done(arg)` | Vráti funkciu `(err, response)`: pri chybe odpovie `$.invalid(err)`, inak odpovie objektom úspechu. | [controller-completion-and-cache](/en/total5/controller-completion-and-cache/) |

## Ďalšie metódy

| Metóda | Čo robí | Recept |
|---|---|---|
| `$.cookie(name, value, expiration)` | Prečíta cookie, alebo ju zapíše, keď odovzdáte hodnotu. | [headers-and-cookies](/en/total5/headers-and-cookies/) |
| `$.csrf()` | Vytvorí token CSRF pre tohto klienta. | [csrf-protection](/en/total5/csrf-protection/) |
| `$.hostname(path)` | Adresa tohto servera: protokol, hostiteľ a cesta, ktorú odovzdáte. | [restbuilder](/en/total5/restbuilder/) |
| `$.action(name, model)` | Spustí akciu s touto požiadavkou (používateľ, query a params). | [calling-actions-from-code](/en/total5/calling-actions-from-code/) |
| `$.transform(name, value, callback)` | Spustí transformáciu s touto požiadavkou. | [transforms](/en/total5/transforms/) |
| `$.authorize(callback)` | Spustí `AUTH()` pre túto požiadavku a nastaví `$.user`; bez callbacku vráti promise. | [controller-completion-and-cache](/en/total5/controller-completion-and-cache/) |
| `$.notmodified(date)` | Odpovie 304 a vráti `true`, keď požiadavka má hlavičku `if-modified-since` s týmto dátumom. | [controller-completion-and-cache](/en/total5/controller-completion-and-cache/) |
| `$.httpcache(date)` | Nastaví hlavičky cache a `last-modified` odpovede. | [controller-completion-and-cache](/en/total5/controller-completion-and-cache/) |
| `$.clear()` | Odstráni dočasné súbory nahrávania. Odstránia sa aj tak po skončení požiadavky. | [file-upload](/en/total5/file-upload/) |
| `$.autoclear(false)` | Ponechá nahrané súbory po požiadavke, aby ste ich mohli použiť neskôr. | [upload-lifecycle-and-href](/en/total5/upload-lifecycle-and-href/) |
| `$.custom()` | Povie frameworku, že odpoviete sami cez `$.res`: nič neodošle. | [controller-completion-and-cache](/en/total5/controller-completion-and-cache/) |
| `$.href(key, value)` | Použite `QUERIFY()` ako v odkazovanom recepte, otestovaný natívny pomocník pre odkazy s query. | [upload-lifecycle-and-href](/en/total5/upload-lifecycle-and-href/) |
| `$.flush()`, `$.resume()`, `$.free()`, `$.cancel()` | Interné metódy: nevolajte ich. | - |

Príklad odpovedá vlastnosťami a volá metódy, ktoré nepotrebujú žiadnu prípravu.

```js controllers/api.js
exports.install = function() {
	ROUTE('GET /info/{a}/{b}/', info);
	ROUTE('POST /body/ @json', body);
	ROUTE('GET /answers/{kind}/', answers);
	ROUTE('GET /callback/{kind}/', callback);
};

function info($) {
	$.json({
		url: $.url,
		method: $.method,
		query: $.query,
		params: $.params,
		ext: $.ext,
		xhr: $.xhr,
		mobile: $.mobile,
		robot: $.robot,
		ua: $.ua,
		ip: $.ip,
		host: $.host,
		referrer: $.referrer,
		protocol: $.protocol,
		hostname: $.hostname('/x/'),
		datatype: $.datatype
	});
}

function body($) {
	$.json({ body: $.body, datatype: $.datatype });
}

function answers($) {
	switch ($.params.kind) {
		case 'json': return $.json({ a: 1 });
		case 'jsonstring': return $.jsonstring('{"a":1}');
		case 'html': return $.html('<b>x</b>');
		case 'plain': return $.plain('x');
		case 'xml': return $.xml('<a>1</a>');
		case 'empty': return $.empty();
		case 'redirect': return $.redirect('/x/', true);
		case 'binary': return $.binary(Buffer.from('abc'), 'application/octet-stream');
		case 'invalid': return $.invalid(409);
		case 'success': return $.success({ id: 7 });
		case 'status': $.response.status = 201; return $.json({ created: true });
		case 'header': $.response.headers['x-example'] = 'yes'; return $.json({});
	}
}

function callback($) {
	switch ($.params.kind) {
		case 'error': return $.callback('failed');
		case 'value': return $.callback(null, { v: 1 });
		case 'nothing': return $.callback(null);
		case 'function': return setImmediate($.callback(), null, { later: true });
		case 'successful': return setImmediate($.successful(function(a, b) { $.json({ a: a, b: b }); }), null, 'x', 'y');
	}
}
```