Globálne názvy Total.js 5

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

Total.js 5 vystavuje globálne funkcie a objekty pre routing, akcie, ukladanie, správy a aplikácie.

Názov	Druh	Čo robí	Recept
`ON`	function	Zaregistruje poslucháča udalosti aplikácie.	events
`ONCE`	function	Ako `ON`, ale poslucháč sa spustí iba pri prvej udalosti.	events
`OFF`	function	Odstráni poslucháča zaregistrovaného cez `ON`.	events
`EMIT`	function	Vyšle udalosť s najviac siedmimi argumentmi.	events
`LOAD`	function	Načíta súbory projektu (kontroléry, definície...); framework ho pri štarte zavolá za vás.	load-and-npminstall
`LOADCONFIG`	function	Spracuje text vo formáte `config` a aplikuje ho na `CONF`.	configuration-file
`LOADRESOURCE`	function	Načíta zdroj (prekladový súbor) z textu alebo z URL.	localization
`PAUSESERVER`	function	Pozastaví alebo obnoví server podľa názvu: počas pozastavenia dostávajú požiadavky stránku 503.	pause-server
`DEBUG`	boolean	`true` v režime debug, `false` v režime release.	release-mode-and-debugging
`CONF`	object	Konfigurácia aplikácie (súbor `config` a jeho predvolené hodnoty).	configuration-file
`DEF`	object	Predvolené obsluhy a nastavenia frameworku (`DEF.onMail`, `DEF.helpers`, `DEF.onCSRFcheck`...).	view-helpers-and-config
`F`	object	Objekt frameworku. `Total` je ten istý objekt.	utility-globals
`Total`	object	Objekt frameworku (rovnaký ako `F`). `Total.run()` spustí aplikáciu.	release-mode-and-debugging
`MAIN`	object	Prázdny objekt, ktorý framework vytvorí pre dáta vašej aplikácie.	utility-globals
`REPO`	object	Prázdny objekt, ktorý framework vytvorí pre vaše vlastné dáta.	utility-globals
`FUNC`	object	Prázdny objekt, ktorý framework vytvorí pre vaše vlastné funkcie.	utility-globals
`TEMP`	object	Objekt pre dočasné dáta; framework ho z času na čas nahradí novým prázdnym objektom.	utility-globals
`NOW`	object	Aktuálny dátum, ktorý framework obnovuje raz za minútu a niektoré volania ako `CACHE`.	utility-globals
`EMPTYARRAY`	object	Zamrazené prázdne pole, aby sa nevytvárali nové.	utility-globals
`EMPTYOBJECT`	object	Zamrazený prázdny objekt, aby sa nevytvárali nové.	utility-globals
`MODS`	object	Načítané moduly z priečinka `modules/` podľa id.	utility-globals
`PLUGINS`	object	Načítané pluginy z priečinka `plugins/` podľa id.	utility-globals
`NOOP`	function	Funkcia, ktorá nerobí nič.	utility-globals
`print`	function	To isté ako `console.log`.	utility-globals
`REQUIRE`	function	Ako `require`, ale hľadá aj v priečinku `node_modules` aplikácie a akceptuje názvy `node:`.	utility-globals

Routy, akcie a middleware

Názov	Druh	Čo robí	Recept
`ROUTE`	function	Deklaruje routu (HTTP, `SOCKET`, `FILE`, `API` alebo záložnú ako `#404`).	http-methods
`NEWACTION`	function	Deklaruje akciu s jej vstupom, params, query, výstupom a oprávneniami.	actions-crud
`NEWSCHEMA`	function	Zoskupí akcie entity pod jeden názov.	schemas
`ACTION`	function	Spustí akciu z vášho kódu.	calling-actions-from-code
`EXEC`	function	Rovnaká funkcia ako `ACTION`.	calling-actions-from-code
`NEWTRANSFORM`	function	Pridá krok do pomenovaného reťazca transformácií.	transforms
`TRANSFORM`	function	Prevedie hodnotu cez reťazec transformácií.	transforms
`MIDDLEWARE`	function	Zaregistruje middleware na použitie v routách cez `#name`.	middleware
`NEWMIDDLEWARE`	function	Rovnaká funkcia ako `MIDDLEWARE`.	middleware
`PROXY`	function	Presmeruje požiadavky pod prefixom URL na iný server.	proxy
`CORS`	function	Nastaví pôvody, ktoré môžu volať aplikáciu z prehliadača.	cors
`ErrorBuilder`	function	Trieda, ktorá zbiera chyby validácie.	errors-and-audit
`SUCCESS`	function	Vráti objekt, ktorý framework odošle pri úspešnej operácii (`{ success: true, value: value }`).	errors-and-audit
`ERROR`	function	`ERROR(name)` vráti callback, ktorý zaznamená prijatú chybu pod týmto názvom; `ERROR()` vráti predvolený chybový callback.	errors-and-audit
`UNAUTHORIZED`	function	`UNAUTHORIZED($, ...permissions)` odpovie 401 a vráti `true`, keď používateľ nemá žiadne z oprávnení; vráti `false`, keď má jedno z nich alebo je superadministrátor.	action-user-and-permissions
`AUTH`	function	Autentifikuje každú požiadavku: funkciou alebo možnosťami vstavaných relácií.	sessions-with-built-in-auth
`BLOCKED`	function	Počíta volania IP adresy a oznámi, keď dosiahla limit.	rate-limiting
`AUDIT`	function	Pridá záznam auditu (používateľ, správa a typ) do súboru logu v `logs/`.	errors-and-audit

Dáta a cache

Názov	Druh	Čo robí	Recept
`NOSQL`	function	Otvorí tabuľku vstavanej NoSQL databázy.	nosql-crud
`DATA`	object	Vstup do query buildera nezávislý od databázy.	data-api
`DB`	function	Spustí dotaz pomocou query buildera (`DB().find('table').where(...).callback($)`); dotaz vykoná driver zaregistrovaný cez `NEWDB`.	query-builder-db
`NEWDB`	function	Zaregistruje databázový driver `function(options, callback)` pre query builder: predvolený, alebo pomenovaný cez `NEWDB('name', fn)`.	query-builder-db
`CACHE`	object	Pamäťové úložisko s expiráciou.	cache
`FILECACHE`	function	Vypočíta výsledok raz a uchová ho v súbore na určitý čas.	filecache
`MEMORIZE`	function	Objekt JSON uložený na disku.	memorize
`FILESTORAGE`	function	Úložisko pre nahrané súbory.	filestorage

Klienti HTTP, WebSocket a správ

Názov	Druh	Čo robí	Recept
`REQUEST`	function	Nízkoúrovňový HTTP klient.	request-and-download
`DOWNLOAD`	function	Uloží odpoveď z URL do súboru.	request-and-download
`RESTBuilder`	function	Builder pre volania iných HTTP API.	restbuilder
`AJAX`	function	`AJAX('METHOD /url/', data, callback)` odošle požiadavku s hlavičkou `x-requested-with` a vráti spracované telo; bez callbacku vráti promise.	ajax-requests
`API`	function	Zavolá operáciu externej služby cez jej driver: `API('service', 'operation', data).callback($)`.	api-drivers
`NEWAPI`	function	Zaregistruje driver `function(options, next)` služby pre `API` s voliteľnou konfiguráciou.	api-drivers
`TotalAPI`	function	Volá službu platformy Total.js pomocou `API('TAPI', name, model)`.	remote-service-boundaries
`WEBSOCKETCLIENT`	function	WebSocket klient pre vašu aplikáciu.	websocket-client
`TMSCLIENT`	function	Klient služby Total Messaging Service.	tms
`PUBLISH`	function	Odošle správu klientom TMS, ktorí ju odoberajú.	tms
`NEWPUBLISH`	function	Deklaruje správu, ktorú aplikácia publikuje.	tms
`SUBSCRIBE`	function	Pridá poslucháča správy, ktorú klienti posielajú aplikácii.	tms
`UNSUBSCRIBE`	function	Odstráni poslucháčov správy TMS.	tms
`NEWSUBSCRIBE`	function	Deklaruje správu, ktorú aplikácia prijíma.	tms
`NEWCALL`	function	Deklaruje funkciu, ktorú môžu klienti TMS volať.	tms
`OPENCLIENT`	function	Pripája sa k OpenPlatform cez WebSocket pre vzdialené volania, udalosti a zdieľané spojenia.	openclient-protocol
`PROXYCLIENT`	function	Pripojí sa k `PROXYSERVER` cez WebSocket a na jeho požiadavky odpovedá lokálnym serverom (port alebo `ip:port`).	proxy-tunnel
`PROXYSERVER`	function	Zmení aplikáciu na tunelový server: HTTP požiadavky endpointu sa posielajú cez WebSocket routu do `PROXYCLIENT`.	proxy-tunnel
`LDAP`	function	Pripojí sa k serveru LDAP (port 389, pokiaľ `ldap.port` nehovorí inak) a vráti výsledok v callbacku.	ldap-openldap
`MAIL`	function	Odošle e-mail, ktorého telom je pohľad.	send-email
`HTMLMAIL`	function	Odošle e-mail, ktorého telom je reťazec HTML.	send-email
`LOGMAIL`	function	Pošle e-mail, ktorého telo je text vypísaný v bloku `<pre>` (telo odovzdajte ako text).	logmail
`Mail`	object	Trieda za odosielaním e-mailov (SMTP).	send-email
`AIMODEL`	function	Spustí požiadavku na jazykový model zaregistrovaný cez `NEWAIMODEL`: `AIMODEL('name').user('text').callback($.callback())`.	ai-models
`AIPARSER`	function	Vytvorí parser pre streamovanú odpoveď poskytovateľa AI (`openai`, `claude`...): `write()` berie kúsky a `end()` vráti obsah, uvažovanie a volania nástrojov.	ai-models
`NEWAIMODEL`	function	Zaregistruje driver `function(ai, done)` jedného alebo viacerých modelov AI pre `AIMODEL` s voliteľnou konfiguráciou.	ai-models
`PYPELINE`	function	Spustí súbor Pythonu z priečinka `pypelines/` (alebo inline kód Pythonu) z aplikácie a komunikuje s ním cez JSON rámce po sockete.	pypeline

Súbory, systém a workery

Názov	Druh	Čo robí	Recept
`PATH`	object	Pomocníci, ktorí vytvárajú cesty v priečinkoch projektu (`PATH.root()`, `PATH.public()`, `PATH.tmp()`...).	file-download
`MERGE`	function	Zaregistruje virtuálny súbor zložený z viacerých súborov, minifikovaný.	minification
`TOUCH`	function	Vymaže minifikované, dočasné a nenájdené položky cache pre URL alebo pre všetky.	touch-static-cache
`CLEANUP`	function	Zničí stream, keď skončil.	cleanup-streams
`BACKUP`	function	Zbalí adresár do jedného súboru.	backup-restore-shell
`RESTORE`	function	Rozbalí súbor vytvorený cez `BACKUP`.	backup-restore-shell
`SHELL`	function	Spustí príkaz shellu v priečinku projektu.	backup-restore-shell
`NPMINSTALL`	function	Nainštaluje balík npm do priečinka modulov aplikácie.	load-and-npminstall
`IMPORT`	function	Stiahne súbor JavaScript z URL a načíta ho.	import-remote-module
`Image`	object	Spracovanie obrázkov pomocou GraphicsMagick alebo ImageMagick.	images
`NEWTHREAD`	function	Spustí worker thread.	workers-and-threads
`NEWFORK`	function	Spustí podriadený proces.	workers-and-threads
`NEWTHREADPOOL`	function	Vytvorí skupinu workerov, ktoré si úlohy požičiavajú po jednom.	thread-pool
`CRON`	function	Spustí funkciu podľa plánu.	cron-jobs
`setTimeout2`	function	`setTimeout` s id: opätovné volanie s rovnakým id nahradí predchádzajúci časovač.	debounce-timers
`clearTimeout2`	function	Zruší časovač vytvorený cez `setTimeout2`.	debounce-timers
`Flow`	object	Správca FlowStreamov aplikácie: `Flow.load(schema)`, `Flow.remove(id)`, `Flow.instances` a `Flow.test()` pre jeden komponent.	flowstream, flowstream-component-test
`FlowStream`	object	Ten istý objekt ako `Flow`.	flowstream
`NEWMACRO`	function	Skompiluje makro z reťazca.	macros
`NEWCOMPONENT`	function	Skompiluje HTML komponentu.	native-components
`COMPONENTATOR`	function	Stiahne balík Componentator do `public/` ako `ui-<name>-<hash>.min.js` a uloží jeho adresu do `F.repo[name]`.	remote-service-boundaries

Nástroje, šablóny a lokalizácia

Názov	Druh	Čo robí	Recept
`U`	object	Nástrojový objekt frameworku (`U.extend()`, `U.clone()`...).	utilities
`Utils`	object	Ten istý objekt ako `U`.	utilities
`UID`	function	Vytvorí krátke jedinečné id zoradené podľa času.	unique-ids-and-hashes
`GUID`	function	Vytvorí náhodný reťazec zadanej dĺžky.	unique-ids-and-hashes
`HASH`	function	Vráti rýchly číselný hash (nie pre heslá).	unique-ids-and-hashes
`CLONE`	function	Vytvorí hlbokú kópiu objektu.	utility-globals
`COPY`	function	Skopíruje vlastnosti prvého objektu do druhého a vráti druhý.	utility-globals
`DIFFARR`	function	Porovná dve polia objektov podľa vlastnosti a vráti objekty na pridanie, dvojice na aktualizáciu a hodnoty na odstránenie.	diffarr-sync-lists
`QUERIFY`	function	Vytvorí URL s reťazcom dotazu z objektu.	utility-globals
`PROMISIFY`	function	`PROMISIFY(fn, a, b, c)` zavolá funkciu, ktorá berie callback ako posledný argument, a vráti promise.	utility-globals
`ENCRYPT`	function	Zmení hodnotu na nepriehľadný token.	encrypt-and-decrypt
`DECRYPT`	function	Prečíta hodnotu z tokenu vytvoreného cez `ENCRYPT`.	encrypt-and-decrypt
`ENCRYPTREQ`	function	Zašifruje hodnotu spolu s user agentom požiadavky (a jej IP adresou v prísnom režime).	request-bound-tokens
`DECRYPTREQ`	function	Prečíta hodnotu vytvorenú cez `ENCRYPTREQ`; nevráti nič, keď požiadavka nezodpovedá.	request-bound-tokens
`LOCALIZE`	function	Vyberie jazyk každej požiadavky.	localization
`TRANSLATE`	function	Preloží texty `@(...)` reťazca do jazyka.	localization
`Tangular`	object	Šablónovací nástroj (`Tangular.render()`).	tangular-templates
`Ta`	object	Iný názov pre `Tangular`, šablónovací nástroj.	template-files
`Thelpers`	object	Pomocné funkcie dostupné v šablónach Tangular.	tangular-templates
`TEMPLATE`	function	Vykreslí šablónu Tangular, ktorou je text, súbor z priečinka `templates` alebo URL, a vráti promise s textom.	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);
}