Globální názvy Total.js 5

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

Total.js 5 vystavuje globální funkce a objekty pro routing, akce, ukládání, poselství a aplikace.

Název	Druh	Co dělá	Recept
`ON`	function	Zaregistruje posluchače události aplikace.	events
`ONCE`	function	Jako `ON`, ale posluchač se spustí jen při první události.	events
`OFF`	function	Odstraní posluchače zaregistrovaného přes `ON`.	events
`EMIT`	function	Vyšle událost s nejvýše sedmi argumenty.	events
`LOAD`	function	Načte soubory projektu (kontrolery, definice...); framework ho při startu zavolá za vás.	load-and-npminstall
`LOADCONFIG`	function	Zpracuje text ve formátu `config` a aplikuje ho na `CONF`.	configuration-file
`LOADRESOURCE`	function	Načte zdroj (překladový soubor) z textu nebo z URL.	localization
`PAUSESERVER`	function	Pozastaví nebo obnoví server podle názvu: během pozastavení dostávají požadavky stránku 503.	pause-server
`DEBUG`	boolean	`true` v režimu debug, `false` v režimu release.	release-mode-and-debugging
`CONF`	object	Konfigurace aplikace (soubor `config` a jeho výchozí hodnoty).	configuration-file
`DEF`	object	Výchozí obsluhy a nastavení frameworku (`DEF.onMail`, `DEF.helpers`, `DEF.onCSRFcheck`...).	view-helpers-and-config
`F`	object	Objekt frameworku. `Total` je stejný objekt.	utility-globals
`Total`	object	Objekt frameworku (stejný jako `F`). `Total.run()` spustí aplikaci.	release-mode-and-debugging
`MAIN`	object	Prázdný objekt, který framework vytvoří pro data vaší aplikace.	utility-globals
`REPO`	object	Prázdný objekt, který framework vytvoří pro vaše vlastní data.	utility-globals
`FUNC`	object	Prázdný objekt, který framework vytvoří pro vaše vlastní funkce.	utility-globals
`TEMP`	object	Objekt pro dočasná data; framework ho čas od času nahradí novým prázdným objektem.	utility-globals
`NOW`	object	Aktuální datum, které framework obnovuje jednou za minutu a některá volání jako `CACHE`.	utility-globals
`EMPTYARRAY`	object	Zmrazené prázdné pole, aby se nevytvářela nová.	utility-globals
`EMPTYOBJECT`	object	Zmrazený prázdný objekt, aby se nevytvářely nové.	utility-globals
`MODS`	object	Načtené moduly ze složky `modules/` podle id.	utility-globals
`PLUGINS`	object	Načtené pluginy ze složky `plugins/` podle id.	utility-globals
`NOOP`	function	Funkce, která nedělá nic.	utility-globals
`print`	function	Totéž jako `console.log`.	utility-globals
`REQUIRE`	function	Jako `require`, ale hledá i ve složce `node_modules` aplikace a přijímá názvy `node:`.	utility-globals

Routy, akce a middleware

Název	Druh	Co dělá	Recept
`ROUTE`	function	Deklaruje routu (HTTP, `SOCKET`, `FILE`, `API` nebo záložní jako `#404`).	http-methods
`NEWACTION`	function	Deklaruje akci s jejím vstupem, params, query, výstupem a oprávněními.	actions-crud
`NEWSCHEMA`	function	Seskupí akce entity pod jeden název.	schemas
`ACTION`	function	Spustí akci z vašeho kódu.	calling-actions-from-code
`EXEC`	function	Stejná funkce jako `ACTION`.	calling-actions-from-code
`NEWTRANSFORM`	function	Přidá krok do pojmenovaného řetězce transformací.	transforms
`TRANSFORM`	function	Provede hodnotu řetězcem transformací.	transforms
`MIDDLEWARE`	function	Zaregistruje middleware pro použití v routách přes `#name`.	middleware
`NEWMIDDLEWARE`	function	Stejná funkce jako `MIDDLEWARE`.	middleware
`PROXY`	function	Přesměruje požadavky pod prefixem URL na jiný server.	proxy
`CORS`	function	Nastaví původy, které mohou volat aplikaci z prohlížeče.	cors
`ErrorBuilder`	function	Třída, která sbírá chyby validace.	errors-and-audit
`SUCCESS`	function	Vrátí objekt, který framework odešle při úspěšné operaci (`{ success: true, value: value }`).	errors-and-audit
`ERROR`	function	`ERROR(name)` vrátí callback, který zaznamená přijatou chybu pod tímto názvem; `ERROR()` vrátí výchozí chybový callback.	errors-and-audit
`UNAUTHORIZED`	function	`UNAUTHORIZED($, ...permissions)` odpoví 401 a vrátí `true`, když uživatel nemá žádné z oprávnění; vrátí `false`, když má jedno z nich nebo je superadministrátor.	action-user-and-permissions
`AUTH`	function	Autentizuje každý požadavek: funkcí nebo volbami vestavěných relací.	sessions-with-built-in-auth
`BLOCKED`	function	Počítá volání IP adresy a oznámí, kdy dosáhla limitu.	rate-limiting
`AUDIT`	function	Přidá záznam auditu (uživatel, zpráva a typ) do souboru logu v `logs/`.	errors-and-audit

Data a cache

Název	Druh	Co dělá	Recept
`NOSQL`	function	Otevře tabulku vestavěné NoSQL databáze.	nosql-crud
`DATA`	object	Vstup do query builderu nezávislý na databázi.	data-api
`DB`	function	Zahájí dotaz pomocí query builderu (`DB().find('table').where(...).callback($)`); dotaz provede driver zaregistrovaný přes `NEWDB`.	query-builder-db
`NEWDB`	function	Zaregistruje databázový driver `function(options, callback)` pro query builder: výchozí, nebo pojmenovaný přes `NEWDB('name', fn)`.	query-builder-db
`CACHE`	object	Úložiště v paměti s expirací.	cache
`FILECACHE`	function	Vypočítá výsledek jednou a uchová ho v souboru po určitou dobu.	filecache
`MEMORIZE`	function	Objekt JSON uložený na disku.	memorize
`FILESTORAGE`	function	Úložiště pro nahrané soubory.	filestorage

Klienti HTTP, WebSocket a zpráv

Název	Druh	Co dělá	Recept
`REQUEST`	function	Nízkoúrovňový HTTP klient.	request-and-download
`DOWNLOAD`	function	Uloží odpověď z URL do souboru.	request-and-download
`RESTBuilder`	function	Builder pro volání jiných HTTP API.	restbuilder
`AJAX`	function	`AJAX('METHOD /url/', data, callback)` odešle požadavek s hlavičkou `x-requested-with` a vrátí zpracované tělo; bez callbacku vrátí promise.	ajax-requests
`API`	function	Zavolá operaci externí služby přes její driver: `API('service', 'operation', data).callback($)`.	api-drivers
`NEWAPI`	function	Zaregistruje driver `function(options, next)` služby pro `API` s volitelnou konfigurací.	api-drivers
`TotalAPI`	function	Volá službu platformy Total.js pomocí `API('TAPI', name, model)`.	remote-service-boundaries
`WEBSOCKETCLIENT`	function	WebSocket klient pro vaši aplikaci.	websocket-client
`TMSCLIENT`	function	Klient služby Total Messaging Service.	tms
`PUBLISH`	function	Odešle zprávu klientům TMS, kteří ji odebírají.	tms
`NEWPUBLISH`	function	Deklaruje zprávu, kterou aplikace publikuje.	tms
`SUBSCRIBE`	function	Přidá posluchače zprávy, kterou klienti posílají aplikaci.	tms
`UNSUBSCRIBE`	function	Odstraní posluchače zprávy TMS.	tms
`NEWSUBSCRIBE`	function	Deklaruje zprávu, kterou aplikace přijímá.	tms
`NEWCALL`	function	Deklaruje funkci, kterou mohou klienti TMS volat.	tms
`OPENCLIENT`	function	Připojuje se k OpenPlatform přes WebSocket pro vzdálená volání, události a sdílená spojení.	openclient-protocol
`PROXYCLIENT`	function	Připojí se k `PROXYSERVER` přes WebSocket a na jeho požadavky odpovídá lokálním serverem (port nebo `ip:port`).	proxy-tunnel
`PROXYSERVER`	function	Změní aplikaci na tunelový server: HTTP požadavky endpointu se posílají přes WebSocket routu do `PROXYCLIENT`.	proxy-tunnel
`LDAP`	function	Připojí se k serveru LDAP (port 389, pokud `ldap.port` neříká jinak) a vrátí výsledek v callbacku.	ldap-openldap
`MAIL`	function	Odešle e-mail, jehož tělem je pohled.	send-email
`HTMLMAIL`	function	Odešle e-mail, jehož tělem je řetězec HTML.	send-email
`LOGMAIL`	function	Pošle e-mail, jehož tělo je text vypsaný v bloku `<pre>` (tělo předejte jako text).	logmail
`Mail`	object	Třída za odesíláním e-mailů (SMTP).	send-email
`AIMODEL`	function	Zahájí požadavek na jazykový model zaregistrovaný přes `NEWAIMODEL`: `AIMODEL('name').user('text').callback($.callback())`.	ai-models
`AIPARSER`	function	Vytvoří parser pro streamovanou odpověď poskytovatele AI (`openai`, `claude`...): `write()` přijímá kousky a `end()` vrátí obsah, uvažování a volání nástrojů.	ai-models
`NEWAIMODEL`	function	Zaregistruje driver `function(ai, done)` jednoho nebo více modelů AI pro `AIMODEL` s volitelnou konfigurací.	ai-models
`PYPELINE`	function	Spustí soubor Pythonu ze složky `pypelines/` (nebo inline kód Pythonu) z aplikace a komunikuje s ním přes JSON rámce po socketu.	pypeline

Soubory, systém a workery

Název	Druh	Co dělá	Recept
`PATH`	object	Pomocníci, kteří vytvářejí cesty ve složkách projektu (`PATH.root()`, `PATH.public()`, `PATH.tmp()`...).	file-download
`MERGE`	function	Zaregistruje virtuální soubor složený z více souborů, minifikovaný.	minification
`TOUCH`	function	Vymaže minifikované, dočasné a nenalezené položky cache pro URL nebo pro všechny.	touch-static-cache
`CLEANUP`	function	Zničí stream, když skončil.	cleanup-streams
`BACKUP`	function	Zabalí adresář do jednoho souboru.	backup-restore-shell
`RESTORE`	function	Rozbalí soubor vytvořený přes `BACKUP`.	backup-restore-shell
`SHELL`	function	Spustí příkaz shellu ve složce projektu.	backup-restore-shell
`NPMINSTALL`	function	Nainstaluje balíček npm do složky modulů aplikace.	load-and-npminstall
`IMPORT`	Funkce	Stáhněte si soubor JavaScript z URL a stáhněte ho.	Dálkové moduly
`Image`	object	Zpracování obrázků pomocí GraphicsMagick nebo ImageMagick.	images
`NEWTHREAD`	function	Spustí worker thread.	workers-and-threads
`NEWFORK`	function	Spustí podřízený proces.	workers-and-threads
`NEWTHREADPOOL`	function	Vytvoří skupinu workerů, které si úlohy půjčují po jednom.	thread-pool
`CRON`	function	Spustí funkci podle plánu.	cron-jobs
`setTimeout2`	function	`setTimeout` s id: opětovné volání se stejným id nahradí předchozí časovač.	debounce-timers
`clearTimeout2`	function	Zruší časovač vytvořený přes `setTimeout2`.	debounce-timers
`Flow`	object	Správce FlowStreamů aplikace: `Flow.load(schema)`, `Flow.remove(id)`, `Flow.instances` a `Flow.test()` pro jednu komponentu.	flowstream, flowstream-component-test
`FlowStream`	object	Stejný objekt jako `Flow`.	flowstream
`NEWMACRO`	function	Zkompiluje makro z řetězce.	macros
`NEWCOMPONENT`	function	Zkompiluje HTML komponenty.	native-components
`COMPONENTATOR`	function	Stáhne balík Componentator do `public/` jako `ui-<name>-<hash>.min.js` a uloží jeho adresu do `F.repo[name]`.	remote-service-boundaries

Nástroje, šablony a lokalizace

Název	Druh	Co dělá	Recept
`U`	object	Nástrojový objekt frameworku (`U.extend()`, `U.clone()`...).	utilities
`Utils`	object	Stejný objekt jako `U`.	utilities
`UID`	function	Vytvoří krátké jedinečné id seřazené podle času.	unique-ids-and-hashes
`GUID`	function	Vytvoří náhodný řetězec zadané délky.	unique-ids-and-hashes
`HASH`	function	Vrátí rychlý číselný hash (ne pro hesla).	unique-ids-and-hashes
`CLONE`	function	Vytvoří hlubokou kopii objektu.	utility-globals
`COPY`	function	Zkopíruje vlastnosti prvního objektu do druhého a vrátí druhý.	utility-globals
`DIFFARR`	function	Porovná dvě pole objektů podle vlastnosti a vrátí objekty k přidání, dvojice k aktualizaci a hodnoty k odstranění.	diffarr-sync-lists
`QUERIFY`	function	Sestaví URL s řetězcem dotazu z objektu.	utility-globals
`PROMISIFY`	function	`PROMISIFY(fn, a, b, c)` zavolá funkci, která bere callback jako poslední argument, a vrátí promise.	utility-globals
`ENCRYPT`	function	Převede hodnotu na neprůhledný token.	encrypt-and-decrypt
`DECRYPT`	function	Přečte hodnotu z tokenu vytvořeného přes `ENCRYPT`.	encrypt-and-decrypt
`ENCRYPTREQ`	function	Zašifruje hodnotu spolu s user agentem požadavku (a jeho IP adresou v přísném režimu).	request-bound-tokens
`DECRYPTREQ`	function	Přečte hodnotu vytvořenou přes `ENCRYPTREQ`; nevrátí nic, když požadavek neodpovídá.	request-bound-tokens
`LOCALIZE`	function	Vybere jazyk každého požadavku.	localization
`TRANSLATE`	function	Přeloží texty `@(...)` řetězce do jazyka.	localization
`Tangular`	object	Šablonovací nástroj (`Tangular.render()`).	tangular-templates
`Ta`	object	Jiný název pro `Tangular`, šablonovací nástroj.	template-files
`Thelpers`	object	Pomocné funkce dostupné v šablonách Tangular.	tangular-templates
`TEMPLATE`	function	Vykreslí šablonu Tangular, kterou je text, soubor ze složky `templates` nebo URL, a vrátí promise s textem.	template-files

controllers/globals.js

exports.install = function() {
	ROUTE('GET /globals/', globals);
};

function globals($) {
	var output = {};
	for (var name of Object.getOwnPropertyNames(globalThis)) {
		var value;
		try {
			value = globalThis[name];
		} catch (e) {
			value = undefined;
		}
		output[name] = typeof(value) === 'function' ? 'function' : value === null ? 'null' : typeof(value);
	}
	$.json(output);
}