Globalne nazwy Total.js 5

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

Total.js 5 przedstawia globalne funkcje i obiekty dla narzędzi routingowych, akcji, przechowywania, wiadomości i aplikacji.

Nazwa	Rodzaj	Co robi	Przepis
`ON`	function	Rejestruje nasłuchiwacza zdarzenia aplikacji.	events
`ONCE`	function	Jak `ON`, ale nasłuchiwacz uruchamia się tylko dla pierwszego zdarzenia.	events
`OFF`	function	Usuwa nasłuchiwacza zarejestrowanego przez `ON`.	events
`EMIT`	function	Emituje zdarzenie z maksymalnie siedmioma argumentami.	events
`LOAD`	function	Ładuje pliki projektu (kontrolery, definicje...); framework wywołuje to za ciebie przy starcie.	load-and-npminstall
`LOADCONFIG`	function	Parsuje tekst w formacie `config` i stosuje go do `CONF`.	configuration-file
`LOADRESOURCE`	function	Ładuje zasób (plik tłumaczeń) z tekstu lub z adresu URL.	localization
`PAUSESERVER`	function	Wstrzymuje lub wznawia serwer według nazwy: podczas wstrzymania żądania otrzymują stronę 503.	pause-server
`DEBUG`	boolean	`true` w trybie debug, `false` w trybie release.	release-mode-and-debugging
`CONF`	object	Konfiguracja aplikacji (plik `config` i jego wartości domyślne).	configuration-file
`DEF`	object	Domyślne obsługi i ustawienia frameworka (`DEF.onMail`, `DEF.helpers`, `DEF.onCSRFcheck`...).	view-helpers-and-config
`F`	object	Obiekt frameworka. `Total` to ten sam obiekt.	utility-globals
`Total`	object	Obiekt frameworka (taki sam jak `F`). `Total.run()` uruchamia aplikację.	release-mode-and-debugging
`MAIN`	object	Pusty obiekt, który framework tworzy na dane twojej aplikacji.	utility-globals
`REPO`	object	Pusty obiekt, który framework tworzy na twoje własne dane.	utility-globals
`FUNC`	object	Pusty obiekt, który framework tworzy na twoje własne funkcje.	utility-globals
`TEMP`	object	Obiekt na dane tymczasowe; framework co jakiś czas zastępuje go nowym pustym obiektem.	utility-globals
`NOW`	object	Bieżąca data, odświeżana przez framework raz na minutę i przez niektóre wywołania, takie jak `CACHE`.	utility-globals
`EMPTYARRAY`	object	Zamrożona pusta tablica, aby nie tworzyć nowych.	utility-globals
`EMPTYOBJECT`	object	Zamrożony pusty obiekt, aby nie tworzyć nowych.	utility-globals
`MODS`	object	Załadowane moduły z folderu `modules/`, według id.	utility-globals
`PLUGINS`	object	Załadowane wtyczki z folderu `plugins/`, według id.	utility-globals
`NOOP`	function	Funkcja, która nic nie robi.	utility-globals
`print`	function	To samo co `console.log`.	utility-globals
`REQUIRE`	function	Jak `require`, ale szuka także w folderze `node_modules` aplikacji i akceptuje nazwy `node:`.	utility-globals

Trasy, akcje i middleware

Nazwa	Rodzaj	Co robi	Przepis
`ROUTE`	function	Deklaruje trasę (HTTP, `SOCKET`, `FILE`, `API` lub zapasową jak `#404`).	http-methods
`NEWACTION`	function	Deklaruje akcję z jej wejściem, params, query, wyjściem i uprawnieniami.	actions-crud
`NEWSCHEMA`	function	Grupuje akcje encji pod jedną nazwą.	schemas
`ACTION`	function	Uruchamia akcję z twojego kodu.	calling-actions-from-code
`EXEC`	function	Ta sama funkcja co `ACTION`.	calling-actions-from-code
`NEWTRANSFORM`	function	Dodaje krok do nazwanego łańcucha transformacji.	transforms
`TRANSFORM`	function	Przepuszcza wartość przez łańcuch transformacji.	transforms
`MIDDLEWARE`	function	Rejestruje middleware do użycia w trasach z `#name`.	middleware
`NEWMIDDLEWARE`	function	Ta sama funkcja co `MIDDLEWARE`.	middleware
`PROXY`	function	Przekazuje żądania pod prefiksem URL na inny serwer.	proxy
`CORS`	function	Ustawia źródła, które mogą wywoływać aplikację z przeglądarki.	cors
`ErrorBuilder`	function	Klasa zbierająca błędy walidacji.	errors-and-audit
`SUCCESS`	function	Zwraca obiekt, który framework wysyła po udanej operacji (`{ success: true, value: value }`).	errors-and-audit
`ERROR`	function	`ERROR(name)` zwraca callback, który zapisuje otrzymany błąd pod tą nazwą; `ERROR()` zwraca domyślny callback błędu.	errors-and-audit
`UNAUTHORIZED`	function	`UNAUTHORIZED($, ...permissions)` odpowiada 401 i zwraca `true`, gdy użytkownik nie ma żadnego z uprawnień; zwraca `false`, gdy ma jedno z nich lub jest super administratorem.	action-user-and-permissions
`AUTH`	function	Uwierzytelnia każde żądanie: funkcją lub opcjami wbudowanych sesji.	sessions-with-built-in-auth
`BLOCKED`	function	Liczy wywołania adresu IP i mówi, kiedy osiągnął limit.	rate-limiting
`AUDIT`	function	Dopisuje wpis audytu (użytkownik, wiadomość i typ) do pliku logu w `logs/`.	errors-and-audit

Dane i pamięć podręczna

Nazwa	Rodzaj	Co robi	Przepis
`NOSQL`	function	Otwiera tabelę wbudowanej bazy NoSQL.	nosql-crud
`DATA`	object	Niezależne od bazy danych wejście do query buildera.	data-api
`DB`	function	Rozpoczyna zapytanie za pomocą query buildera (`DB().find('table').where(...).callback($)`); zapytanie wykonuje sterownik zarejestrowany przez `NEWDB`.	query-builder-db
`NEWDB`	function	Rejestruje sterownik bazy danych `function(options, callback)` dla query buildera: domyślny lub nazwany przez `NEWDB('name', fn)`.	query-builder-db
`CACHE`	object	Magazyn w pamięci z wygasaniem.	cache
`FILECACHE`	function	Oblicza wynik raz i przechowuje go w pliku przez jakiś czas.	filecache
`MEMORIZE`	function	Obiekt JSON zapisany na dysku.	memorize
`FILESTORAGE`	function	Magazyn przesłanych plików.	filestorage

Klienci HTTP, WebSocket i komunikatów

Nazwa	Rodzaj	Co robi	Przepis
`REQUEST`	function	Niskopoziomowy klient HTTP.	request-and-download
`DOWNLOAD`	function	Zapisuje odpowiedź z adresu URL do pliku.	request-and-download
`RESTBuilder`	function	Builder wywołań innych API HTTP.	restbuilder
`AJAX`	function	`AJAX('METHOD /url/', data, callback)` wysyła żądanie z nagłówkiem `x-requested-with` i zwraca sparsowaną treść; bez callbacku zwraca promise.	ajax-requests
`API`	function	Wywołuje operację zewnętrznej usługi przez jej sterownik: `API('service', 'operation', data).callback($)`.	api-drivers
`NEWAPI`	function	Rejestruje sterownik `function(options, next)` usługi dla `API`, z opcjonalną konfiguracją.	api-drivers
`TotalAPI`	function	Wywołuje usługę platformy Total.js przez `API('TAPI', name, model)`.	remote-service-boundaries
`WEBSOCKETCLIENT`	function	Klient WebSocket dla twojej aplikacji.	websocket-client
`TMSCLIENT`	function	Klient usługi Total Messaging Service.	tms
`PUBLISH`	function	Wysyła wiadomość do klientów TMS, którzy ją subskrybują.	tms
`NEWPUBLISH`	function	Deklaruje wiadomość, którą aplikacja publikuje.	tms
`SUBSCRIBE`	function	Dodaje nasłuchiwacza wiadomości, którą klienci wysyłają do aplikacji.	tms
`UNSUBSCRIBE`	function	Usuwa nasłuchiwaczy wiadomości TMS.	tms
`NEWSUBSCRIBE`	function	Deklaruje wiadomość, którą aplikacja odbiera.	tms
`NEWCALL`	function	Deklaruje funkcję, którą mogą wywoływać klienci TMS.	tms
`OPENCLIENT`	function	Łączy się z OpenPlatform przez WebSocket do wywołań zdalnych, zdarzeń i współdzielonych połączeń.	openclient-protocol
`PROXYCLIENT`	function	Łączy się z `PROXYSERVER` przez WebSocket i odpowiada na jego żądania lokalnym serwerem (port lub `ip:port`).	proxy-tunnel
`PROXYSERVER`	function	Zamienia aplikację w serwer tunelu: żądania HTTP endpointu są wysyłane trasą WebSocket do `PROXYCLIENT`.	proxy-tunnel
`LDAP`	function	Łączy się z serwerem LDAP (port 389, chyba że `ldap.port` mówi inaczej) i wywołuje callback z wynikiem.	ldap-openldap
`MAIL`	function	Wysyła e-mail, którego treścią jest widok.	send-email
`HTMLMAIL`	function	Wysyła e-mail, którego treścią jest ciąg HTML.	send-email
`LOGMAIL`	function	Wysyła e-mail, którego treścią jest tekst wypisany w bloku `<pre>` (przekaż treść jako tekst).	logmail
`Mail`	object	Klasa stojąca za wysyłaniem poczty (SMTP).	send-email
`AIMODEL`	function	Rozpoczyna żądanie do modelu językowego zarejestrowanego przez `NEWAIMODEL`: `AIMODEL('name').user('text').callback($.callback())`.	ai-models
`AIPARSER`	function	Tworzy parser strumieniowanej odpowiedzi dostawcy AI (`openai`, `claude`...): `write()` przyjmuje kawałki, a `end()` zwraca treść, rozumowanie i wywołania narzędzi.	ai-models
`NEWAIMODEL`	function	Rejestruje sterownik `function(ai, done)` jednego lub kilku modeli AI dla `AIMODEL`, z opcjonalną konfiguracją.	ai-models
`PYPELINE`	function	Uruchamia z aplikacji plik Pythona z folderu `pypelines/` (lub kod Pythona w treści) i rozmawia z nim ramkami JSON przez gniazdo.	pypeline

Pliki, system i workery

Nazwa	Rodzaj	Co robi	Przepis
`PATH`	object	Pomocnicy budujący ścieżki w folderach projektu (`PATH.root()`, `PATH.public()`, `PATH.tmp()`...).	file-download
`MERGE`	function	Rejestruje wirtualny plik złożony z kilku plików, zminifikowany.	minification
`TOUCH`	function	Czyści zbuforowane wpisy zminifikowane, tymczasowe i nieznalezione dla adresu URL lub dla wszystkich.	touch-static-cache
`CLEANUP`	function	Niszczy strumień po jego zakończeniu.	cleanup-streams
`BACKUP`	function	Pakuje katalog do jednego pliku.	backup-restore-shell
`RESTORE`	function	Rozpakowuje plik utworzony przez `BACKUP`.	backup-restore-shell
`SHELL`	function	Uruchamia polecenie powłoki w folderze projektu.	backup-restore-shell
`NPMINSTALL`	function	Instaluje pakiet npm w folderze modułów aplikacji.	load-and-npminstall
`IMPORT`	function	Pobiera plik JavaScript z adresu URL i ładuje go.	import-remote-module
`Image`	object	Przetwarzanie obrazów za pomocą GraphicsMagick lub ImageMagick.	images
`NEWTHREAD`	function	Uruchamia worker thread.	workers-and-threads
`NEWFORK`	function	Uruchamia proces potomny.	workers-and-threads
`NEWTHREADPOOL`	function	Tworzy pulę workerów, które zadania pożyczają po jednym.	thread-pool
`CRON`	function	Uruchamia funkcję według harmonogramu.	cron-jobs
`setTimeout2`	function	`setTimeout` z id: ponowne wywołanie z tym samym id zastępuje poprzedni timer.	debounce-timers
`clearTimeout2`	function	Anuluje timer utworzony przez `setTimeout2`.	debounce-timers
`Flow`	object	Menedżer FlowStreamów aplikacji: `Flow.load(schema)`, `Flow.remove(id)`, `Flow.instances` i `Flow.test()` dla jednego komponentu.	flowstream, flowstream-component-test
`FlowStream`	object	Ten sam obiekt co `Flow`.	flowstream
`NEWMACRO`	function	Kompiluje makro z ciągu znaków.	macros
`NEWCOMPONENT`	function	Kompiluje HTML komponentu.	native-components
`COMPONENTATOR`	function	Pobiera pakiet Componentator do `public/` jako `ui-<name>-<hash>.min.js` i zapisuje jego adres w `F.repo[name]`.	remote-service-boundaries

Narzędzia, szablony i lokalizacja

Nazwa	Rodzaj	Co robi	Przepis
`U`	object	Obiekt narzędziowy frameworka (`U.extend()`, `U.clone()`...).	utilities
`Utils`	object	Ten sam obiekt co `U`.	utilities
`UID`	function	Tworzy krótkie unikalne id posortowane według czasu.	unique-ids-and-hashes
`GUID`	function	Tworzy losowy ciąg o podanej długości.	unique-ids-and-hashes
`HASH`	function	Zwraca szybki skrót liczbowy (nie do haseł).	unique-ids-and-hashes
`CLONE`	function	Tworzy głęboką kopię obiektu.	utility-globals
`COPY`	function	Kopiuje właściwości pierwszego obiektu do drugiego i zwraca drugi.	utility-globals
`DIFFARR`	function	Porównuje dwie tablice obiektów według właściwości i zwraca obiekty do dodania, pary do zaktualizowania i wartości do usunięcia.	diffarr-sync-lists
`QUERIFY`	function	Buduje adres URL z ciągiem zapytania z obiektu.	utility-globals
`PROMISIFY`	function	`PROMISIFY(fn, a, b, c)` wywołuje funkcję, która przyjmuje callback jako ostatni argument, i zwraca promise.	utility-globals
`ENCRYPT`	function	Zamienia wartość w nieprzezroczysty token.	encrypt-and-decrypt
`DECRYPT`	function	Odczytuje wartość z tokenu utworzonego przez `ENCRYPT`.	encrypt-and-decrypt
`ENCRYPTREQ`	function	Szyfruje wartość wraz z user agentem żądania (i jego adresem IP w trybie ścisłym).	request-bound-tokens
`DECRYPTREQ`	function	Odczytuje wartość utworzoną przez `ENCRYPTREQ`; nic nie zwraca, gdy żądanie nie pasuje.	request-bound-tokens
`LOCALIZE`	function	Wybiera język każdego żądania.	localization
`TRANSLATE`	function	Tłumaczy teksty `@(...)` w ciągu na język.	localization
`Tangular`	object	Silnik szablonów (`Tangular.render()`).	tangular-templates
`Ta`	object	Inna nazwa `Tangular`, silnika szablonów.	template-files
`Thelpers`	object	Funkcje pomocnicze dostępne w szablonach Tangular.	tangular-templates
`TEMPLATE`	function	Renderuje szablon Tangular, którym jest tekst, plik z folderu `templates` lub adres URL, i zwraca promise z tekstem.	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);
}