Wereldnaam van Total.js 5

Total.js 5 · total5@0.0.19 referenceglobals Uitgevoerd met Total.js 5

Total.js 5 toont wereldwijde functies en objecten voor routing, acties, opslag, boodschappen en applicatie-instrumenten.

Naam	Soort	Wat het doet	Recept
`ON`	function	Registreert een listener voor een applicatie-event.	events
`ONCE`	function	Zoals `ON`, maar de listener draait alleen voor het eerste event.	events
`OFF`	function	Verwijdert een met `ON` geregistreerde listener.	events
`EMIT`	function	Zendt een event uit met maximaal zeven argumenten.	events
`LOAD`	function	Laadt de bestanden van het project (controllers, definities...); het framework roept het bij het starten voor je aan.	load-and-npminstall
`LOADCONFIG`	function	Parsed een tekst in het `config`-formaat en past die toe op `CONF`.	configuration-file
`LOADRESOURCE`	function	Laadt een resource (een vertaalbestand) uit een tekst of van een URL.	localization
`PAUSESERVER`	function	Pauzeert of hervat de server op naam: tijdens de pauze krijgen verzoeken een 503-pagina.	pause-server
`DEBUG`	boolean	`true` in debugmodus, `false` in releasemodus.	release-mode-and-debugging
`CONF`	object	De configuratie van de applicatie (het bestand `config` en zijn standaardwaarden).	configuration-file
`DEF`	object	Standaardhandlers en -instellingen van het framework (`DEF.onMail`, `DEF.helpers`, `DEF.onCSRFcheck`...).	view-helpers-and-config
`F`	object	Het frameworkobject. `Total` is hetzelfde object.	utility-globals
`Total`	object	Het frameworkobject (hetzelfde als `F`). `Total.run()` start de applicatie.	release-mode-and-debugging
`MAIN`	object	Een leeg object dat het framework maakt voor de gegevens van je applicatie.	utility-globals
`REPO`	object	Een leeg object dat het framework maakt voor je eigen gegevens.	utility-globals
`FUNC`	object	Een leeg object dat het framework maakt voor je eigen functies.	utility-globals
`TEMP`	object	Een object voor tijdelijke gegevens; het framework vervangt het af en toe door een nieuw leeg object.	utility-globals
`NOW`	object	De huidige datum, door het framework eens per minuut ververst en door sommige aanroepen zoals `CACHE`.	utility-globals
`EMPTYARRAY`	object	Een bevroren lege array, om te voorkomen dat er nieuwe worden gemaakt.	utility-globals
`EMPTYOBJECT`	object	Een bevroren leeg object, om te voorkomen dat er nieuwe worden gemaakt.	utility-globals
`MODS`	object	De geladen modules van de map `modules/`, op id.	utility-globals
`PLUGINS`	object	De geladen plugins van de map `plugins/`, op id.	utility-globals
`NOOP`	function	Een functie die niets doet.	utility-globals
`print`	function	Hetzelfde als `console.log`.	utility-globals
`REQUIRE`	function	Zoals `require`, maar zoekt ook in de map `node_modules` van de applicatie en accepteert `node:`-namen.	utility-globals

Routing, acties en middleware

Naam	Soort	Wat het doet	Recept
`ROUTE`	function	Declareert een route (HTTP, `SOCKET`, `FILE`, `API` of een fallback zoals `#404`).	http-methods
`NEWACTION`	function	Declareert een actie met zijn input, params, query, output en rechten.	actions-crud
`NEWSCHEMA`	function	Groepeert de acties van een entiteit onder één naam.	schemas
`ACTION`	function	Voert een actie uit vanuit je eigen code.	calling-actions-from-code
`EXEC`	function	Dezelfde functie als `ACTION`.	calling-actions-from-code
`NEWTRANSFORM`	function	Voegt een stap toe aan een benoemde keten van transformaties.	transforms
`TRANSFORM`	function	Laat een waarde door een keten van transformaties lopen.	transforms
`MIDDLEWARE`	function	Registreert een middleware voor gebruik in routes met `#name`.	middleware
`NEWMIDDLEWARE`	function	Dezelfde functie als `MIDDLEWARE`.	middleware
`PROXY`	function	Stuurt de verzoeken onder een URL-voorvoegsel door naar een andere server.	proxy
`CORS`	function	Stelt de origins in die de applicatie vanuit een browser mogen aanroepen.	cors
`ErrorBuilder`	function	De klasse die validatiefouten verzamelt.	errors-and-audit
`SUCCESS`	function	Geeft het object terug dat het framework verstuurt bij een geslaagde bewerking (`{ success: true, value: value }`).	errors-and-audit
`ERROR`	function	`ERROR(name)` geeft een callback terug die de ontvangen fout onder die naam logt; `ERROR()` geeft de standaard foutcallback terug.	errors-and-audit
`UNAUTHORIZED`	function	`UNAUTHORIZED($, ...permissions)` antwoordt 401 en geeft `true` terug als de gebruiker geen van de rechten heeft; het geeft `false` terug als de gebruiker er een heeft of superbeheerder is.	action-user-and-permissions
`AUTH`	function	Authenticeert elk verzoek: een functie, of de opties van de ingebouwde sessies.	sessions-with-built-in-auth
`BLOCKED`	function	Telt de aanroepen van een IP-adres en meldt wanneer het de limiet heeft bereikt.	rate-limiting
`AUDIT`	function	Voegt een auditregel (gebruiker, bericht en type) toe aan een logbestand in `logs/`.	errors-and-audit

Gegevens en cache

Naam	Soort	Wat het doet	Recept
`NOSQL`	function	Opent een tabel van de ingebouwde NoSQL-database.	nosql-crud
`DATA`	object	Databaseonafhankelijke ingang naar de query builder.	data-api
`DB`	function	Start een query met de query builder (`DB().find('table').where(...).callback($)`); de query wordt uitgevoerd door de driver die met `NEWDB` is geregistreerd.	query-builder-db
`NEWDB`	function	Registreert een databasedriver `function(options, callback)` voor de query builder: de standaard, of een benoemde met `NEWDB('name', fn)`.	query-builder-db
`CACHE`	object	Een opslag in het geheugen met verloop.	cache
`FILECACHE`	function	Berekent een resultaat één keer en bewaart het een tijd in een bestand.	filecache
`MEMORIZE`	function	Een JSON-object opgeslagen op schijf.	memorize
`FILESTORAGE`	function	Een opslag voor geüploade bestanden.	filestorage

HTTP-, WebSocket- en berichtenclients

Naam	Soort	Wat het doet	Recept
`REQUEST`	function	HTTP-client op laag niveau.	request-and-download
`DOWNLOAD`	function	Slaat het antwoord van een URL op in een bestand.	request-and-download
`RESTBuilder`	function	Builder voor aanroepen van andere HTTP-API's.	restbuilder
`AJAX`	function	`AJAX('METHOD /url/', data, callback)` doet een verzoek met de header `x-requested-with` en geeft de geparsede body terug; het geeft een promise terug als er geen callback is.	ajax-requests
`API`	function	Roept een bewerking van een externe dienst aan via zijn driver: `API('service', 'operation', data).callback($)`.	api-drivers
`NEWAPI`	function	Registreert de driver `function(options, next)` van een dienst voor `API`, met een optionele configuratie.	api-drivers
`TotalAPI`	function	Roept een dienst van het Total.js-platform aan via `API('TAPI', name, model)`.	remote-service-boundaries
`WEBSOCKETCLIENT`	function	Een WebSocket-client voor je applicatie.	websocket-client
`TMSCLIENT`	function	Een client van de Total Messaging Service.	tms
`PUBLISH`	function	Stuurt een bericht naar de TMS-clients die erop geabonneerd zijn.	tms
`NEWPUBLISH`	function	Declareert een bericht dat de applicatie publiceert.	tms
`SUBSCRIBE`	function	Voegt een listener toe voor een bericht dat clients naar de applicatie sturen.	tms
`UNSUBSCRIBE`	function	Verwijdert de listeners van een TMS-bericht.	tms
`NEWSUBSCRIBE`	function	Declareert een bericht dat de applicatie ontvangt.	tms
`NEWCALL`	function	Declareert een functie die TMS-clients kunnen aanroepen.	tms
`OPENCLIENT`	function	Verbindt met OpenPlatform via WebSocket voor externe aanroepen, gebeurtenissen en gedeelde verbindingen.	openclient-protocol
`PROXYCLIENT`	function	Verbindt via WebSocket met een `PROXYSERVER` en beantwoordt zijn verzoeken met een lokale server (een poort of `ip:port`).	proxy-tunnel
`PROXYSERVER`	function	Maakt van de applicatie een tunnelserver: de HTTP-verzoeken van een endpoint worden via een WebSocket-route naar een `PROXYCLIENT` gestuurd.	proxy-tunnel
`LDAP`	function	Maakt verbinding met een LDAP-server (poort 389 tenzij `ldap.port` iets anders zegt) en roept terug met het resultaat.	ldap-openldap
`MAIL`	function	Verstuurt een e-mail waarvan de body een view is.	send-email
`HTMLMAIL`	function	Verstuurt een e-mail waarvan de body een HTML-string is.	send-email
`LOGMAIL`	function	Verstuurt een e-mail waarvan de body een tekst is die in een `<pre>`-blok wordt afgedrukt (geef de body als tekst door).	logmail
`Mail`	object	De klasse achter het versturen van e-mail (SMTP).	send-email
`AIMODEL`	function	Start een verzoek aan een taalmodel dat met `NEWAIMODEL` is geregistreerd: `AIMODEL('name').user('text').callback($.callback())`.	ai-models
`AIPARSER`	function	Maakt een parser voor het gestreamde antwoord van een AI-aanbieder (`openai`, `claude`...): `write()` neemt stukken aan en `end()` geeft de inhoud, de redenering en de toolaanroepen terug.	ai-models
`NEWAIMODEL`	function	Registreert de driver `function(ai, done)` van een of meer AI-modellen voor `AIMODEL`, met een optionele configuratie.	ai-models
`PYPELINE`	function	Voert vanuit de applicatie een Python-bestand uit de map `pypelines/` (of inline Python-code) uit en praat ermee via JSON-frames over een socket.	pypeline

Bestanden, systeem en workers

Naam	Soort	Wat het doet	Recept
`PATH`	object	Helpers die paden bouwen in de projectmappen (`PATH.root()`, `PATH.public()`, `PATH.tmp()`...).	file-download
`MERGE`	function	Registreert een virtueel, geminificeerd bestand dat uit meerdere bestanden bestaat.	minification
`TOUCH`	function	Wist de gecachete geminificeerde, tijdelijke en niet-gevonden items van een URL, of van alle.	touch-static-cache
`CLEANUP`	function	Vernietigt een stream wanneer die klaar is.	cleanup-streams
`BACKUP`	function	Pakt een map in één bestand.	backup-restore-shell
`RESTORE`	function	Pakt een met `BACKUP` gemaakt bestand uit.	backup-restore-shell
`SHELL`	function	Voert een shellcommando uit in de projectmap.	backup-restore-shell
`NPMINSTALL`	function	Installeert een npm-pakket in de modulemap van de applicatie.	load-and-npminstall
`IMPORT`	function	Downloadt een JavaScript-bestand van een URL en laadt het.	import-remote-module
`Image`	object	Beeldverwerking met GraphicsMagick of ImageMagick.	images
`NEWTHREAD`	function	Start een worker thread.	workers-and-threads
`NEWFORK`	function	Start een kindproces.	workers-and-threads
`NEWTHREADPOOL`	function	Maakt een pool van workers die taken één voor één lenen.	thread-pool
`CRON`	function	Voert een functie volgens een schema uit.	cron-jobs
`setTimeout2`	function	`setTimeout` met een id: opnieuw aanroepen met dezelfde id vervangt de vorige timer.	debounce-timers
`clearTimeout2`	function	Annuleert een met `setTimeout2` gemaakte timer.	debounce-timers
`Flow`	object	De beheerder van de FlowStreams van de applicatie: `Flow.load(schema)`, `Flow.remove(id)`, `Flow.instances` en `Flow.test()` voor één component.	flowstream, flowstream-component-test
`FlowStream`	object	Hetzelfde object als `Flow`.	flowstream
`NEWMACRO`	function	Compileert een macro uit een string.	macros
`NEWCOMPONENT`	function	Compileert de HTML van een component.	native-components
`COMPONENTATOR`	function	Downloadt een Componentator-bundel naar `public/` als `ui-<name>-<hash>.min.js` en slaat het adres op in `F.repo[name]`.	remote-service-boundaries

Hulpmiddelen, templates en lokalisatie

Naam	Soort	Wat het doet	Recept
`U`	object	Het hulpobject van het framework (`U.extend()`, `U.clone()`...).	utilities
`Utils`	object	Hetzelfde object als `U`.	utilities
`UID`	function	Maakt een korte unieke id, gesorteerd op tijd.	unique-ids-and-hashes
`GUID`	function	Maakt een willekeurige string van de opgegeven lengte.	unique-ids-and-hashes
`HASH`	function	Geeft een snelle numerieke hash terug (niet voor wachtwoorden).	unique-ids-and-hashes
`CLONE`	function	Maakt een diepe kopie van een object.	utility-globals
`COPY`	function	Kopieert de eigenschappen van het eerste object naar het tweede en geeft het tweede terug.	utility-globals
`DIFFARR`	function	Vergelijkt twee arrays van objecten op een eigenschap en geeft de objecten om toe te voegen, de paren om bij te werken en de waarden om te verwijderen.	diffarr-sync-lists
`QUERIFY`	function	Bouwt een URL met querystring uit een object.	utility-globals
`PROMISIFY`	function	`PROMISIFY(fn, a, b, c)` roept een functie aan die een callback als laatste argument neemt en geeft een promise terug.	utility-globals
`ENCRYPT`	function	Zet een waarde om in een ondoorzichtig token.	encrypt-and-decrypt
`DECRYPT`	function	Leest een waarde uit een met `ENCRYPT` gemaakt token.	encrypt-and-decrypt
`ENCRYPTREQ`	function	Versleutelt een waarde samen met de user agent van een verzoek (en zijn IP-adres in strikte modus).	request-bound-tokens
`DECRYPTREQ`	function	Leest een met `ENCRYPTREQ` gemaakte waarde; geeft niets terug als het verzoek niet overeenkomt.	request-bound-tokens
`LOCALIZE`	function	Kiest de taal van elk verzoek.	localization
`TRANSLATE`	function	Vertaalt de `@(...)`-teksten van een string naar een taal.	localization
`Tangular`	object	De template-engine (`Tangular.render()`).	tangular-templates
`Ta`	object	Een andere naam voor `Tangular`, de template-engine.	template-files
`Thelpers`	object	De helperfuncties die beschikbaar zijn in Tangular-templates.	tangular-templates
`TEMPLATE`	function	Rendert een Tangular-template die een tekst, een bestand uit de map `templates` of een URL is, en geeft een promise met de tekst terug.	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);
}