Globala namn på Total.js 5

Total.js 5 · total5@0.0.19 referenceglobals Körd med Total.js 5

Total.js 5 visar globala funktioner och objekt för routing, åtgärder, lagring, meddelande och applikationsverktyg.

Namn	Slag	Vad det gör	Recept
`ON`	function	Registrerar en lyssnare för en applikationshändelse.	events
`ONCE`	function	Som `ON`, men lyssnaren körs bara för den första händelsen.	events
`OFF`	function	Tar bort en lyssnare som registrerats med `ON`.	events
`EMIT`	function	Skickar en händelse med upp till sju argument.	events
`LOAD`	function	Laddar projektets filer (controllers, definitioner...); ramverket anropar den åt dig vid start.	load-and-npminstall
`LOADCONFIG`	function	Tolkar en text i formatet `config` och tillämpar den på `CONF`.	configuration-file
`LOADRESOURCE`	function	Laddar en resurs (en översättningsfil) från en text eller från en URL.	localization
`PAUSESERVER`	function	Pausar eller återupptar servern efter namn: medan den är pausad får begäranden en 503-sida.	pause-server
`DEBUG`	boolean	`true` i debugläge, `false` i releaseläge.	release-mode-and-debugging
`CONF`	object	Applikationens konfiguration (filen `config` och dess standardvärden).	configuration-file
`DEF`	object	Ramverkets standardhanterare och inställningar (`DEF.onMail`, `DEF.helpers`, `DEF.onCSRFcheck`...).	view-helpers-and-config
`F`	object	Ramverksobjektet. `Total` är samma objekt.	utility-globals
`Total`	object	Ramverksobjektet (samma som `F`). `Total.run()` startar applikationen.	release-mode-and-debugging
`MAIN`	object	Ett tomt objekt som ramverket skapar för din applikations data.	utility-globals
`REPO`	object	Ett tomt objekt som ramverket skapar för dina egna data.	utility-globals
`FUNC`	object	Ett tomt objekt som ramverket skapar för dina egna funktioner.	utility-globals
`TEMP`	object	Ett objekt för temporära data; ramverket ersätter det då och då med ett nytt tomt objekt.	utility-globals
`NOW`	object	Aktuellt datum, uppdaterat av ramverket en gång i minuten och av vissa anrop som `CACHE`.	utility-globals
`EMPTYARRAY`	object	En fryst tom array, för att undvika att skapa nya.	utility-globals
`EMPTYOBJECT`	object	Ett fryst tomt objekt, för att undvika att skapa nya.	utility-globals
`MODS`	object	De laddade modulerna i mappen `modules/`, efter id.	utility-globals
`PLUGINS`	object	De laddade pluginen i mappen `plugins/`, efter id.	utility-globals
`NOOP`	function	En funktion som inte gör något.	utility-globals
`print`	function	Samma som `console.log`.	utility-globals
`REQUIRE`	function	Som `require`, men letar också i applikationens mapp `node_modules` och accepterar `node:`-namn.	utility-globals

Routning, åtgärder och middleware

Namn	Slag	Vad det gör	Recept
`ROUTE`	function	Deklarerar en route (HTTP, `SOCKET`, `FILE`, `API` eller en reserv som `#404`).	http-methods
`NEWACTION`	function	Deklarerar en åtgärd med dess indata, params, query, utdata och behörigheter.	actions-crud
`NEWSCHEMA`	function	Grupperar en entitets åtgärder under ett namn.	schemas
`ACTION`	function	Kör en åtgärd från din egen kod.	calling-actions-from-code
`EXEC`	function	Samma funktion som `ACTION`.	calling-actions-from-code
`NEWTRANSFORM`	function	Lägger till ett steg i en namngiven kedja av transformeringar.	transforms
`TRANSFORM`	function	Skickar ett värde genom en kedja av transformeringar.	transforms
`MIDDLEWARE`	function	Registrerar en middleware för användning i routes med `#name`.	middleware
`NEWMIDDLEWARE`	function	Samma funktion som `MIDDLEWARE`.	middleware
`PROXY`	function	Vidarebefordrar begäranden under ett URL-prefix till en annan server.	proxy
`CORS`	function	Anger vilka ursprung som får anropa applikationen från en webbläsare.	cors
`ErrorBuilder`	function	Klassen som samlar valideringsfel.	errors-and-audit
`SUCCESS`	function	Returnerar objektet som ramverket skickar vid en lyckad operation (`{ success: true, value: value }`).	errors-and-audit
`ERROR`	function	`ERROR(name)` returnerar en callback som loggar felet den får under det namnet; `ERROR()` returnerar standardcallbacken för fel.	errors-and-audit
`UNAUTHORIZED`	function	`UNAUTHORIZED($, ...permissions)` svarar 401 och returnerar `true` när användaren inte har någon av behörigheterna; den returnerar `false` när användaren har en av dem eller är superadministratör.	action-user-and-permissions
`AUTH`	function	Autentiserar varje begäran: en funktion, eller alternativen för de inbyggda sessionerna.	sessions-with-built-in-auth
`BLOCKED`	function	Räknar anropen från en IP-adress och talar om när den nått gränsen.	rate-limiting
`AUDIT`	function	Lägger till en granskningspost (användare, meddelande och typ) i en loggfil i `logs/`.	errors-and-audit

Data och cache

Namn	Slag	Vad det gör	Recept
`NOSQL`	function	Öppnar en tabell i den inbyggda NoSQL-databasen.	nosql-crud
`DATA`	object	Databasoberoende ingång till query buildern.	data-api
`DB`	function	Startar en fråga med query buildern (`DB().find('table').where(...).callback($)`); frågan körs av drivrutinen som registrerats med `NEWDB`.	query-builder-db
`NEWDB`	function	Registrerar en databasdrivrutin `function(options, callback)` för query buildern: standardrutinen, eller en namngiven med `NEWDB('name', fn)`.	query-builder-db
`CACHE`	object	Ett minneslager med utgång.	cache
`FILECACHE`	function	Beräknar ett resultat en gång och behåller det i en fil en stund.	filecache
`MEMORIZE`	function	Ett JSON-objekt sparat på disk.	memorize
`FILESTORAGE`	function	Ett lager för uppladdade filer.	filestorage

HTTP-, WebSocket- och meddelandeklienter

Namn	Slag	Vad det gör	Recept
`REQUEST`	function	HTTP-klient på låg nivå.	request-and-download
`DOWNLOAD`	function	Sparar svaret från en URL i en fil.	request-and-download
`RESTBuilder`	function	Builder för anrop till andra HTTP-API:er.	restbuilder
`AJAX`	function	`AJAX('METHOD /url/', data, callback)` gör en begäran med huvudet `x-requested-with` och returnerar den tolkade kroppen; den returnerar ett promise när det inte finns någon callback.	ajax-requests
`API`	function	Anropar en operation i en extern tjänst via dess drivrutin: `API('service', 'operation', data).callback($)`.	api-drivers
`NEWAPI`	function	Registrerar drivrutinen `function(options, next)` för en tjänst till `API`, med valfri konfiguration.	api-drivers
`TotalAPI`	function	Anropar en tjänst på Total.js-plattformen via `API('TAPI', name, model)`.	remote-service-boundaries
`WEBSOCKETCLIENT`	function	En WebSocket-klient för din applikation.	websocket-client
`TMSCLIENT`	function	En klient för Total Messaging Service.	tms
`PUBLISH`	function	Skickar ett meddelande till de TMS-klienter som prenumererar på det.	tms
`NEWPUBLISH`	function	Deklarerar ett meddelande som applikationen publicerar.	tms
`SUBSCRIBE`	function	Lägger till en lyssnare för ett meddelande som klienter skickar till applikationen.	tms
`UNSUBSCRIBE`	function	Tar bort lyssnarna för ett TMS-meddelande.	tms
`NEWSUBSCRIBE`	function	Deklarerar ett meddelande som applikationen tar emot.	tms
`NEWCALL`	function	Deklarerar en funktion som TMS-klienter kan anropa.	tms
`OPENCLIENT`	function	Ansluter till OpenPlatform via WebSocket för fjärranrop, händelser och delade anslutningar.	openclient-protocol
`PROXYCLIENT`	function	Ansluter till en `PROXYSERVER` via WebSocket och svarar på dess förfrågningar med en lokal server (en port eller `ip:port`).	proxy-tunnel
`PROXYSERVER`	function	Gör applikationen till en tunnelserver: HTTP-förfrågningarna till en endpoint skickas via en WebSocket-route till en `PROXYCLIENT`.	proxy-tunnel
`LDAP`	function	Ansluter till en LDAP-server (port 389 om inte `ldap.port` säger något annat) och anropar tillbaka med resultatet.	ldap-openldap
`MAIL`	function	Skickar ett e-postmeddelande vars kropp är en vy.	send-email
`HTMLMAIL`	function	Skickar ett e-postmeddelande vars kropp är en HTML-sträng.	send-email
`LOGMAIL`	function	Skickar ett e-postmeddelande vars innehåll är en text utskriven i ett `<pre>`-block (skicka innehållet som text).	logmail
`Mail`	object	Klassen bakom e-postutskicket (SMTP).	send-email
`AIMODEL`	function	Startar en begäran till en språkmodell som registrerats med `NEWAIMODEL`: `AIMODEL('name').user('text').callback($.callback())`.	ai-models
`AIPARSER`	function	Skapar en parser för det strömmade svaret från en AI-leverantör (`openai`, `claude`...): `write()` tar emot bitar och `end()` returnerar innehållet, resonemanget och verktygsanropen.	ai-models
`NEWAIMODEL`	function	Registrerar drivrutinen `function(ai, done)` för en eller flera AI-modeller till `AIMODEL`, med valfri konfiguration.	ai-models
`PYPELINE`	function	Kör från applikationen en Python-fil i mappen `pypelines/` (eller Python-kod inline) och pratar med den via JSON-ramar över en socket.	pypeline

Filer, system och workers

Namn	Slag	Vad det gör	Recept
`PATH`	object	Hjälpfunktioner som bygger sökvägar i projektmapparna (`PATH.root()`, `PATH.public()`, `PATH.tmp()`...).	file-download
`MERGE`	function	Registrerar en virtuell, minifierad fil som består av flera filer.	minification
`TOUCH`	function	Rensar de cachade minifierade, temporära och ej funna posterna för en URL, eller för alla.	touch-static-cache
`CLEANUP`	function	Förstör en ström när den är klar.	cleanup-streams
`BACKUP`	function	Packar en katalog i en fil.	backup-restore-shell
`RESTORE`	function	Packar upp en fil som skapats med `BACKUP`.	backup-restore-shell
`SHELL`	function	Kör ett skalkommando i projektets mapp.	backup-restore-shell
`NPMINSTALL`	function	Installerar ett npm-paket i applikationens modulmapp.	load-and-npminstall
`IMPORT`	function	Laddar ner en JavaScript-fil från en URL och laddar den.	import-remote-module
`Image`	object	Bildbehandling med GraphicsMagick eller ImageMagick.	images
`NEWTHREAD`	function	Startar en worker thread.	workers-and-threads
`NEWFORK`	function	Startar en barnprocess.	workers-and-threads
`NEWTHREADPOOL`	function	Skapar en pool av workers som jobb lånar en i taget.	thread-pool
`CRON`	function	Kör en funktion enligt ett schema.	cron-jobs
`setTimeout2`	function	`setTimeout` med ett id: att anropa den igen med samma id ersätter den tidigare timern.	debounce-timers
`clearTimeout2`	function	Avbryter en timer som skapats med `setTimeout2`.	debounce-timers
`Flow`	object	Hanteraren för applikationens FlowStreams: `Flow.load(schema)`, `Flow.remove(id)`, `Flow.instances` och `Flow.test()` för en komponent.	flowstream, flowstream-component-test
`FlowStream`	object	Samma objekt som `Flow`.	flowstream
`NEWMACRO`	function	Kompilerar ett makro från en sträng.	macros
`NEWCOMPONENT`	function	Kompilerar HTML:en för en komponent.	native-components
`COMPONENTATOR`	function	Hämtar ett Componentator-paket till `public/` som `ui-<name>-<hash>.min.js` och sparar adressen i `F.repo[name]`.	remote-service-boundaries

Verktyg, mallar och lokalisering

Namn	Slag	Vad det gör	Recept
`U`	object	Ramverkets verktygsobjekt (`U.extend()`, `U.clone()`...).	utilities
`Utils`	object	Samma objekt som `U`.	utilities
`UID`	function	Skapar ett kort unikt id sorterat efter tid.	unique-ids-and-hashes
`GUID`	function	Skapar en slumpmässig sträng med angiven längd.	unique-ids-and-hashes
`HASH`	function	Returnerar en snabb numerisk hash (inte för lösenord).	unique-ids-and-hashes
`CLONE`	function	Gör en djup kopia av ett objekt.	utility-globals
`COPY`	function	Kopierar det första objektets egenskaper till det andra och returnerar det andra.	utility-globals
`DIFFARR`	function	Jämför två arrayer av objekt efter en egenskap och returnerar objekten att lägga till, paren att uppdatera och värdena att ta bort.	diffarr-sync-lists
`QUERIFY`	function	Bygger en URL med frågesträng från ett objekt.	utility-globals
`PROMISIFY`	function	`PROMISIFY(fn, a, b, c)` anropar en funktion som tar en callback som sista argument och returnerar ett promise.	utility-globals
`ENCRYPT`	function	Gör om ett värde till en ogenomskinlig token.	encrypt-and-decrypt
`DECRYPT`	function	Läser ett värde från en token som skapats med `ENCRYPT`.	encrypt-and-decrypt
`ENCRYPTREQ`	function	Krypterar ett värde tillsammans med en begärans user agent (och dess IP-adress i strikt läge).	request-bound-tokens
`DECRYPTREQ`	function	Läser ett värde som skapats med `ENCRYPTREQ`; returnerar inget när begäran inte matchar.	request-bound-tokens
`LOCALIZE`	function	Väljer språk för varje begäran.	localization
`TRANSLATE`	function	Översätter `@(...)`-texterna i en sträng till ett språk.	localization
`Tangular`	object	Mallmotorn (`Tangular.render()`).	tangular-templates
`Ta`	object	Ett annat namn för `Tangular`, mallmotorn.	template-files
`Thelpers`	object	Hjälpfunktionerna som finns i Tangular-mallar.	tangular-templates
`TEMPLATE`	function	Renderar en Tangular-mall som är en text, en fil i mappen `templates` eller en URL, och returnerar ett promise med texten.	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);
}