Глобални имена на Total.js 5

Total.js 5 · total5@0.0.19 referenceglobals Изпълнено с Total.js 5

Total.js 5 показва глобални функции и обекти за маршрутизиране, действия, съхранение, съобщения и приложения.

Име	Вид	Какво прави	Рецепта
`ON`	function	Регистрира слушател за събитие на приложението.	events
`ONCE`	function	Като `ON`, но слушателят се изпълнява само за първото събитие.	events
`OFF`	function	Премахва слушател, регистриран с `ON`.	events
`EMIT`	function	Излъчва събитие с до седем аргумента.	events
`LOAD`	function	Зарежда файловете на проекта (контролери, дефиниции...); фреймуъркът го извиква вместо вас при старт.	load-and-npminstall
`LOADCONFIG`	function	Анализира текст във формата `config` и го прилага към `CONF`.	configuration-file
`LOADRESOURCE`	function	Зарежда ресурс (файл с преводи) от текст или от URL.	localization
`PAUSESERVER`	function	Паузира или възобновява сървъра по име: докато е на пауза, заявките получават страница 503.	pause-server
`DEBUG`	boolean	`true` в режим debug, `false` в режим release.	release-mode-and-debugging
`CONF`	object	Конфигурацията на приложението (файлът `config` и стойностите му по подразбиране).	configuration-file
`DEF`	object	Манипулатори и настройки по подразбиране на фреймуърка (`DEF.onMail`, `DEF.helpers`, `DEF.onCSRFcheck`...).	view-helpers-and-config
`F`	object	Обектът на фреймуърка. `Total` е същият обект.	utility-globals
`Total`	object	Обектът на фреймуърка (същият като `F`). `Total.run()` стартира приложението.	release-mode-and-debugging
`MAIN`	object	Празен обект, който фреймуъркът създава за данните на вашето приложение.	utility-globals
`REPO`	object	Празен обект, който фреймуъркът създава за вашите собствени данни.	utility-globals
`FUNC`	object	Празен обект, който фреймуъркът създава за вашите собствени функции.	utility-globals
`TEMP`	object	Обект за временни данни; фреймуъркът го заменя от време на време с нов празен обект.	utility-globals
`NOW`	object	Текущата дата, обновявана от фреймуърка веднъж на минута и от някои извиквания като `CACHE`.	utility-globals
`EMPTYARRAY`	object	Замразен празен масив, за да се избегне създаването на нови.	utility-globals
`EMPTYOBJECT`	object	Замразен празен обект, за да се избегне създаването на нови.	utility-globals
`MODS`	object	Заредените модули от папката `modules/`, по идентификатор.	utility-globals
`PLUGINS`	object	Заредените плъгини от папката `plugins/`, по идентификатор.	utility-globals
`NOOP`	function	Функция, която не прави нищо.	utility-globals
`print`	function	Същото като `console.log`.	utility-globals
`REQUIRE`	function	Като `require`, но търси и в папката `node_modules` на приложението и приема имена `node:`.	utility-globals

Маршрутизиране, действия и middleware

Име	Вид	Какво прави	Рецепта
`ROUTE`	function	Декларира маршрут (HTTP, `SOCKET`, `FILE`, `API` или резервен като `#404`).	http-methods
`NEWACTION`	function	Декларира действие с неговия вход, params, query, изход и разрешения.	actions-crud
`NEWSCHEMA`	function	Групира действията на една същност под едно име.	schemas
`ACTION`	function	Изпълнява действие от вашия собствен код.	calling-actions-from-code
`EXEC`	function	Същата функция като `ACTION`.	calling-actions-from-code
`NEWTRANSFORM`	function	Добавя стъпка към именувана верига от трансформации.	transforms
`TRANSFORM`	function	Прекарва стойност през верига от трансформации.	transforms
`MIDDLEWARE`	function	Регистрира middleware за използване в маршрути с `#name`.	middleware
`NEWMIDDLEWARE`	function	Същата функция като `MIDDLEWARE`.	middleware
`PROXY`	function	Препраща заявките под префикс на URL към друг сървър.	proxy
`CORS`	function	Задава произходите, които могат да извикват приложението от браузър.	cors
`ErrorBuilder`	function	Класът, който събира грешките при валидиране.	errors-and-audit
`SUCCESS`	function	Връща обекта, който фреймуъркът изпраща при успешна операция (`{ success: true, value: value }`).	errors-and-audit
`ERROR`	function	`ERROR(name)` връща callback, който записва получената грешка под това име; `ERROR()` връща callback за грешки по подразбиране.	errors-and-audit
`UNAUTHORIZED`	function	`UNAUTHORIZED($, ...permissions)` отговаря 401 и връща `true`, когато потребителят няма нито едно от разрешенията; връща `false`, когато има едно от тях или е супер администратор.	action-user-and-permissions
`AUTH`	function	Автентикира всяка заявка: функция или опциите на вградените сесии.	sessions-with-built-in-auth
`BLOCKED`	function	Брои извикванията на един IP адрес и казва кога е достигнал лимита.	rate-limiting
`AUDIT`	function	Добавя запис за одит (потребител, съобщение и тип) към лог файл в `logs/`.	errors-and-audit

Данни и кеш

Име	Вид	Какво прави	Рецепта
`NOSQL`	function	Отваря таблица на вградената NoSQL база данни.	nosql-crud
`DATA`	object	Независим от базата данни вход към query builder.	data-api
`DB`	function	Започва заявка с query builder (`DB().find('table').where(...).callback($)`); заявката се изпълнява от драйвера, регистриран с `NEWDB`.	query-builder-db
`NEWDB`	function	Регистрира драйвер за база данни `function(options, callback)` за query builder: този по подразбиране или именуван с `NEWDB('name', fn)`.	query-builder-db
`CACHE`	object	Хранилище в паметта с изтичане.	cache
`FILECACHE`	function	Изчислява резултат веднъж и го пази във файл за известно време.	filecache
`MEMORIZE`	function	JSON обект, записан на диска.	memorize
`FILESTORAGE`	function	Хранилище за качени файлове.	filestorage

HTTP, WebSocket и клиенти за съобщения

Име	Вид	Какво прави	Рецепта
`REQUEST`	function	HTTP клиент на ниско ниво.	request-and-download
`DOWNLOAD`	function	Записва отговора на URL във файл.	request-and-download
`RESTBuilder`	function	Builder за извиквания към други HTTP API.	restbuilder
`AJAX`	function	`AJAX('METHOD /url/', data, callback)` прави заявка със заглавие `x-requested-with` и връща анализираното тяло; връща promise, когато няма callback.	ajax-requests
`API`	function	Извиква операция на външна услуга чрез нейния драйвер: `API('service', 'operation', data).callback($)`.	api-drivers
`NEWAPI`	function	Регистрира драйвера `function(options, next)` на услуга за `API`, с по избор конфигурация.	api-drivers
`TotalAPI`	function	Извиква услуга на платформата Total.js чрез `API('TAPI', name, model)`.	remote-service-boundaries
`WEBSOCKETCLIENT`	function	WebSocket клиент за вашето приложение.	websocket-client
`TMSCLIENT`	function	Клиент на Total Messaging Service.	tms
`PUBLISH`	function	Изпраща съобщение до TMS клиентите, абонирани за него.	tms
`NEWPUBLISH`	function	Декларира съобщение, което приложението публикува.	tms
`SUBSCRIBE`	function	Добавя слушател за съобщение, което клиентите изпращат към приложението.	tms
`UNSUBSCRIBE`	function	Премахва слушателите на TMS съобщение.	tms
`NEWSUBSCRIBE`	function	Декларира съобщение, което приложението получава.	tms
`NEWCALL`	function	Декларира функция, която TMS клиентите могат да извикват.	tms
`OPENCLIENT`	function	Свързва се с OpenPlatform през WebSocket за отдалечени извиквания, събития и споделени връзки.	openclient-protocol
`PROXYCLIENT`	function	Свързва се с `PROXYSERVER` през WebSocket и отговаря на заявките му с локален сървър (порт или `ip:port`).	proxy-tunnel
`PROXYSERVER`	function	Превръща приложението в тунелен сървър: HTTP заявките на endpoint се изпращат през WebSocket маршрут към `PROXYCLIENT`.	proxy-tunnel
`LDAP`	function	Свързва се с LDAP сървър (порт 389, освен ако `ldap.port` не казва друго) и извиква обратно с резултата.	ldap-openldap
`MAIL`	function	Изпраща имейл, чието тяло е изглед.	send-email
`HTMLMAIL`	function	Изпраща имейл, чието тяло е HTML низ.	send-email
`LOGMAIL`	function	Изпраща имейл, чието тяло е текст, изписан в блок `<pre>` (подайте тялото като текст).	logmail
`Mail`	object	Класът зад изпращането на имейл (SMTP).	send-email
`AIMODEL`	function	Започва заявка към езиков модел, регистриран с `NEWAIMODEL`: `AIMODEL('name').user('text').callback($.callback())`.	ai-models
`AIPARSER`	function	Създава парсер за поточния отговор на доставчик на AI (`openai`, `claude`...): `write()` приема части, а `end()` връща съдържанието, разсъжденията и извикванията на инструменти.	ai-models
`NEWAIMODEL`	function	Регистрира драйвера `function(ai, done)` на един или повече AI модели за `AIMODEL`, с по избор конфигурация.	ai-models
`PYPELINE`	function	Изпълнява от приложението Python файл от папката `pypelines/` (или вграден Python код) и комуникира с него чрез JSON рамки през сокет.	pypeline

Файлове, система и workers

Име	Вид	Какво прави	Рецепта
`PATH`	object	Помощни функции, които изграждат пътища в папките на проекта (`PATH.root()`, `PATH.public()`, `PATH.tmp()`...).	file-download
`MERGE`	function	Регистрира виртуален файл, съставен от няколко файла, минимизиран.	minification
`TOUCH`	function	Изчиства кешираните минимизирани, временни и ненамерени записи на URL или на всички.	touch-static-cache
`CLEANUP`	function	Унищожава поток, когато е приключил.	cleanup-streams
`BACKUP`	function	Пакетира директория в един файл.	backup-restore-shell
`RESTORE`	function	Разпакетира файл, създаден с `BACKUP`.	backup-restore-shell
`SHELL`	function	Изпълнява shell команда в папката на проекта.	backup-restore-shell
`NPMINSTALL`	function	Инсталира npm пакет в папката за модули на приложението.	load-and-npminstall
`IMPORT`	function	Изтегля JavaScript файл от URL и го зарежда.	import-remote-module
`Image`	object	Обработка на изображения с GraphicsMagick или ImageMagick.	images
`NEWTHREAD`	function	Стартира worker thread.	workers-and-threads
`NEWFORK`	function	Стартира дъщерен процес.	workers-and-threads
`NEWTHREADPOOL`	function	Създава група от workers, които задачите вземат назаем по един.	thread-pool
`CRON`	function	Изпълнява функция по график.	cron-jobs
`setTimeout2`	function	`setTimeout` с идентификатор: повторното му извикване със същия идентификатор заменя предишния таймер.	debounce-timers
`clearTimeout2`	function	Отменя таймер, създаден със `setTimeout2`.	debounce-timers
`Flow`	object	Мениджърът на FlowStreams на приложението: `Flow.load(schema)`, `Flow.remove(id)`, `Flow.instances` и `Flow.test()` за един компонент.	flowstream, flowstream-component-test
`FlowStream`	object	Същият обект като `Flow`.	flowstream
`NEWMACRO`	function	Компилира макрос от низ.	macros
`NEWCOMPONENT`	function	Компилира HTML на компонент.	native-components
`COMPONENTATOR`	function	Изтегля пакет Componentator в `public/` като `ui-<name>-<hash>.min.js` и записва адреса му в `F.repo[name]`.	remote-service-boundaries

Помощни средства, шаблони и локализация

Име	Вид	Какво прави	Рецепта
`U`	object	Помощният обект на фреймуърка (`U.extend()`, `U.clone()`...).	utilities
`Utils`	object	Същият обект като `U`.	utilities
`UID`	function	Създава кратък уникален идентификатор, сортиран по време.	unique-ids-and-hashes
`GUID`	function	Създава случаен низ с дадената дължина.	unique-ids-and-hashes
`HASH`	function	Връща бърз числов хеш (не за пароли).	unique-ids-and-hashes
`CLONE`	function	Прави дълбоко копие на обект.	utility-globals
`COPY`	function	Копира свойствата на първия обект във втория и връща втория.	utility-globals
`DIFFARR`	function	Сравнява два масива от обекти по свойство и връща обектите за добавяне, двойките за актуализиране и стойностите за премахване.	diffarr-sync-lists
`QUERIFY`	function	Изгражда URL с низ на заявката от обект.	utility-globals
`PROMISIFY`	function	`PROMISIFY(fn, a, b, c)` извиква функция, която приема callback като последен аргумент, и връща promise.	utility-globals
`ENCRYPT`	function	Превръща стойност в непрозрачен токен.	encrypt-and-decrypt
`DECRYPT`	function	Чете стойност от токен, създаден с `ENCRYPT`.	encrypt-and-decrypt
`ENCRYPTREQ`	function	Криптира стойност заедно с user agent на заявка (и нейния IP адрес в строг режим).	request-bound-tokens
`DECRYPTREQ`	function	Чете стойност, създадена с `ENCRYPTREQ`; не връща нищо, когато заявката не съвпада.	request-bound-tokens
`LOCALIZE`	function	Избира езика на всяка заявка.	localization
`TRANSLATE`	function	Превежда текстовете `@(...)` на низ на даден език.	localization
`Tangular`	object	Шаблонният механизъм (`Tangular.render()`).	tangular-templates
`Ta`	object	Друго име на `Tangular`, шаблонния механизъм.	template-files
`Thelpers`	object	Помощните функции, налични в шаблоните Tangular.	tangular-templates
`TEMPLATE`	function	Рендира шаблон Tangular, който е текст, файл от папката `templates` или URL, и връща promise с текста.	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);
}