ForgeDokumentáció
hu

Dokumentáció

Globális nevek Total.js 5

Total.js 5 · total5@0.0.19 referenceglobals Total.js 5-tel lefuttatva

A Total.js 5 globális funkciókat és objektumokat mutat be az útmutató, a cselekvés, a tárolás, az üzenetküldés és az alkalmazás eszközei számára.

NévFajtaMit csinálRecept
ONfunctionFigyelőt regisztrál egy alkalmazásszintű eseményre.events
ONCEfunctionMint az ON, de a figyelő csak az első eseménynél fut le.events
OFFfunctionEltávolít egy ON-nal regisztrált figyelőt.events
EMITfunctionEseményt bocsát ki legfeljebb hét argumentummal.events
LOADfunctionBetölti a projekt fájljait (vezérlők, definíciók...); a keretrendszer induláskor meghívja helyetted.load-and-npminstall
LOADCONFIGfunctionÉrtelmez egy config formátumú szöveget, és alkalmazza a CONF-ra.configuration-file
LOADRESOURCEfunctionBetölt egy erőforrást (fordítási fájlt) szövegből vagy URL-ről.localization
PAUSESERVERfunctionNév szerint szünetelteti vagy folytatja a szervert: szünet alatt a kérések 503-as oldalt kapnak.pause-server
DEBUGbooleantrue debug módban, false release módban.release-mode-and-debugging
CONFobjectAz alkalmazás konfigurációja (a config fájl és az alapértékei).configuration-file
DEFobjectA keretrendszer alapértelmezett kezelői és beállításai (DEF.onMail, DEF.helpers, DEF.onCSRFcheck...).view-helpers-and-config
FobjectA keretrendszer objektuma. A Total ugyanez az objektum.utility-globals
TotalobjectA keretrendszer objektuma (ugyanaz, mint az F). A Total.run() elindítja az alkalmazást.release-mode-and-debugging
MAINobjectEgy üres objektum, amelyet a keretrendszer az alkalmazásod adataihoz hoz létre.utility-globals
REPOobjectEgy üres objektum, amelyet a keretrendszer a saját adataidhoz hoz létre.utility-globals
FUNCobjectEgy üres objektum, amelyet a keretrendszer a saját függvényeidhez hoz létre.utility-globals
TEMPobjectIdeiglenes adatok objektuma; a keretrendszer időnként új, üres objektumra cseréli.utility-globals
NOWobjectA jelenlegi dátum, amelyet a keretrendszer percenként egyszer, és néhány hívás, például a CACHE frissít.utility-globals
EMPTYARRAYobjectEgy befagyasztott üres tömb, hogy ne kelljen újakat létrehozni.utility-globals
EMPTYOBJECTobjectEgy befagyasztott üres objektum, hogy ne kelljen újakat létrehozni.utility-globals
MODSobjectA modules/ mappa betöltött moduljai azonosító szerint.utility-globals
PLUGINSobjectA plugins/ mappa betöltött bővítményei azonosító szerint.utility-globals
NOOPfunctionEgy függvény, amely nem csinál semmit.utility-globals
printfunctionUgyanaz, mint a console.log.utility-globals
REQUIREfunctionMint a require, de az alkalmazás node_modules mappájában is keres, és elfogadja a node: neveket.utility-globals

Útvonalak, műveletek és middleware

NévFajtaMit csinálRecept
ROUTEfunctionÚtvonalat deklarál (HTTP, SOCKET, FILE, API vagy tartalék, például #404).http-methods
NEWACTIONfunctionMűveletet deklarál a bemenetével, params, query, kimenetével és jogosultságaival.actions-crud
NEWSCHEMAfunctionEgy entitás műveleteit egy név alá csoportosítja.schemas
ACTIONfunctionMűveletet futtat a saját kódodból.calling-actions-from-code
EXECfunctionUgyanaz a függvény, mint az ACTION.calling-actions-from-code
NEWTRANSFORMfunctionLépést ad hozzá egy elnevezett átalakítási lánchoz.transforms
TRANSFORMfunctionEgy értéket átvezet egy átalakítási láncon.transforms
MIDDLEWAREfunctionMiddleware-t regisztrál az útvonalakban a #name-mel való használathoz.middleware
NEWMIDDLEWAREfunctionUgyanaz a függvény, mint a MIDDLEWARE.middleware
PROXYfunctionEgy URL-előtag alatti kéréseket továbbít egy másik szerverre.proxy
CORSfunctionBeállítja azokat a forrásokat, amelyek böngészőből hívhatják az alkalmazást.cors
ErrorBuilderfunctionAz osztály, amely az érvényesítési hibákat gyűjti.errors-and-audit
SUCCESSfunctionVisszaadja azt az objektumot, amelyet a keretrendszer sikeres művelet esetén küld ({ success: true, value: value }).errors-and-audit
ERRORfunctionAz ERROR(name) visszahívást ad vissza, amely a kapott hibát ezen a néven naplózza; az ERROR() az alapértelmezett hiba-visszahívást adja.errors-and-audit
UNAUTHORIZEDfunctionAz UNAUTHORIZED($, ...permissions) 401-gyel válaszol, és true-t ad vissza, ha a felhasználónak egyik jogosultsága sincs; false-t ad vissza, ha van egyik, vagy szuperadminisztrátor.action-user-and-permissions
AUTHfunctionMinden kérést hitelesít: egy függvény, vagy a beépített munkamenetek beállításai.sessions-with-built-in-auth
BLOCKEDfunctionSzámolja egy IP-cím hívásait, és jelzi, mikor érte el a korlátot.rate-limiting
AUDITfunctionAuditbejegyzést (felhasználó, üzenet és típus) fűz egy naplófájlhoz a logs/ mappában.errors-and-audit

Adatok és gyorsítótár

NévFajtaMit csinálRecept
NOSQLfunctionMegnyitja a beépített NoSQL adatbázis egy tábláját.nosql-crud
DATAobjectAdatbázis-független belépési pont a query builderhez.data-api
DBfunctionLekérdezést indít a query builderrel (DB().find('table').where(...).callback($)); a lekérdezést a NEWDB-vel regisztrált driver futtatja.query-builder-db
NEWDBfunctionAdatbázis-drivert regisztrál a query builderhez function(options, callback) alakban: az alapértelmezettet, vagy egy névvel ellátottat a NEWDB('name', fn)-nel.query-builder-db
CACHEobjectMemóriabeli tároló lejárattal.cache
FILECACHEfunctionEgyszer kiszámít egy eredményt, és egy ideig fájlban tartja.filecache
MEMORIZEfunctionLemezre mentett JSON objektum.memorize
FILESTORAGEfunctionFeltöltött fájlok tárolója.filestorage

HTTP-, WebSocket- és üzenetküldő kliensek

NévFajtaMit csinálRecept
REQUESTfunctionAlacsony szintű HTTP-kliens.request-and-download
DOWNLOADfunctionEgy URL válaszát fájlba menti.request-and-download
RESTBuilderfunctionÉpítő más HTTP API-k hívásához.restbuilder
AJAXfunctionAz AJAX('METHOD /url/', data, callback) kérést küld az x-requested-with fejléccel, és visszaadja az értelmezett törzset; visszahívás nélkül promise-t ad vissza.ajax-requests
APIfunctionEgy külső szolgáltatás műveletét hívja meg a drivere segítségével: API('service', 'operation', data).callback($).api-drivers
NEWAPIfunctionRegisztrálja egy szolgáltatás function(options, next) driverét az API-hoz, opcionális konfigurációval.api-drivers
TotalAPIfunctionA Total.js platform egyik szolgáltatását hívja meg az API('TAPI', name, model) használatával.remote-service-boundaries
WEBSOCKETCLIENTfunctionWebSocket-kliens az alkalmazásodhoz.websocket-client
TMSCLIENTfunctionA Total Messaging Service kliense.tms
PUBLISHfunctionÜzenetet küld az arra feliratkozott TMS-klienseknek.tms
NEWPUBLISHfunctionDeklarál egy üzenetet, amelyet az alkalmazás közzétesz.tms
SUBSCRIBEfunctionFigyelőt ad hozzá egy olyan üzenethez, amelyet a kliensek az alkalmazásnak küldenek.tms
UNSUBSCRIBEfunctionEltávolítja egy TMS-üzenet figyelőit.tms
NEWSUBSCRIBEfunctionDeklarál egy üzenetet, amelyet az alkalmazás fogad.tms
NEWCALLfunctionDeklarál egy függvényt, amelyet a TMS-kliensek meghívhatnak.tms
OPENCLIENTfunctionWebSocketen kapcsolódik az OpenPlatformhoz távoli hívásokhoz, eseményekhez és megosztott kapcsolatokhoz.openclient-protocol
PROXYCLIENTFunkciókEgy PROXYSERVER-hez csatlakozik a WebSocket felett, és kéréseit egy helyi szerverrel (port vagy ip:port) válaszolja.Proxy alagút
PROXYSERVERfunctionAz alkalmazást alagútszerverré alakítja: egy endpoint HTTP kérései egy WebSocket útvonalon át egy PROXYCLIENT-hez kerülnek.proxy-tunnel
LDAPfunctionCsatlakozik egy LDAP-szerverhez (a 389-es porton, hacsak az ldap.port mást nem mond), és az eredménnyel visszahív.ldap-openldap
MAILfunctionE-mailt küld, amelynek törzse egy nézet.send-email
HTMLMAILfunctionE-mailt küld, amelynek törzse egy HTML-karakterlánc.send-email
LOGMAILfunctionE-mailt küld, amelynek törzse egy <pre> blokkban kiírt szöveg (a törzset szövegként add át).logmail
MailobjectAz e-mail-küldés (SMTP) mögötti osztály.send-email
AIMODELfunctionKérést indít egy NEWAIMODEL-lel regisztrált nyelvi modellhez: AIMODEL('name').user('text').callback($.callback()).ai-models
AIPARSERfunctionÉrtelmezőt hoz létre egy AI-szolgáltató streamelt válaszához (openai, claude...): a write() darabokat fogad, az end() pedig visszaadja a tartalmat, a gondolatmenetet és az eszközhívásokat.ai-models
NEWAIMODELfunctionRegisztrálja egy vagy több AI-modell function(ai, done) driverét az AIMODEL-hez, opcionális konfigurációval.ai-models
PYPELINEfunctionAz alkalmazásból futtat egy Python-fájlt a pypelines/ mappából (vagy beágyazott Python-kódot), és JSON keretekkel kommunikál vele egy socketen.pypeline

Fájlok, rendszer és workerek

NévFajtaMit csinálRecept
PATHobjectSegédfüggvények, amelyek útvonalakat építenek a projektmappákban (PATH.root(), PATH.public(), PATH.tmp()...).file-download
MERGEfunctionRegisztrál egy több fájlból álló, minifikált virtuális fájlt.minification
TOUCHfunctionTörli egy URL (vagy az összes) gyorsítótárazott minifikált, ideiglenes és nem található bejegyzéseit.touch-static-cache
CLEANUPfunctionMegsemmisít egy streamet, amikor az befejeződött.cleanup-streams
BACKUPfunctionEgy könyvtárat egyetlen fájlba csomagol.backup-restore-shell
RESTOREfunctionKicsomagol egy BACKUP-pal készített fájlt.backup-restore-shell
SHELLfunctionShell-parancsot futtat a projekt mappájában.backup-restore-shell
NPMINSTALLfunctionTelepít egy npm-csomagot az alkalmazás modulmappájába.load-and-npminstall
IMPORTfunctionLetölt egy JavaScript-fájlt egy URL-ről, és betölti.import-remote-module
ImageobjectKépfeldolgozás GraphicsMagick vagy ImageMagick segítségével.images
NEWTHREADfunctionElindít egy worker threadet.workers-and-threads
NEWFORKfunctionElindít egy gyermekfolyamatot.workers-and-threads
NEWTHREADPOOLfunctionWorkerek készletét hozza létre, amelyeket a feladatok egyenként kölcsönöznek.thread-pool
CRONfunctionÜtemezés szerint futtat egy függvényt.cron-jobs
setTimeout2functionsetTimeout azonosítóval: ugyanazzal az azonosítóval újra meghívva lecseréli az előző időzítőt.debounce-timers
clearTimeout2functionMegszakít egy setTimeout2-vel létrehozott időzítőt.debounce-timers
FlowobjectAz alkalmazás FlowStreamjeinek kezelője: Flow.load(schema), Flow.remove(id), Flow.instances és Flow.test() egy komponenshez.flowstream, flowstream-component-test
FlowStreamobjectUgyanaz az objektum, mint a Flow.flowstream
NEWMACROfunctionMakrót fordít le egy karakterláncból.macros
NEWCOMPONENTfunctionLefordítja egy komponens HTML-jét.native-components
COMPONENTATORfunctionLetölt egy Componentator-csomagot a public/ könyvtárba ui-<name>-<hash>.min.js néven, és a címét az F.repo[name] értékben tárolja.remote-service-boundaries

Segédeszközök, sablonok és lokalizáció

NévFajtaMit csinálRecept
UobjectA keretrendszer segédobjektuma (U.extend(), U.clone()...).utilities
UtilsobjectUgyanaz az objektum, mint az U.utilities
UIDfunctionRövid, idő szerint rendezett egyedi azonosítót hoz létre.unique-ids-and-hashes
GUIDfunctionVéletlenszerű karakterláncot hoz létre a megadott hosszal.unique-ids-and-hashes
HASHfunctionGyors numerikus hasht ad vissza (nem jelszavakhoz).unique-ids-and-hashes
CLONEfunctionMély másolatot készít egy objektumról.utility-globals
COPYfunctionAz első objektum tulajdonságait átmásolja a másodikba, és a másodikat adja vissza.utility-globals
DIFFARRfunctionKét objektumtömböt hasonlít össze egy tulajdonság alapján, és visszaadja a hozzáadandó objektumokat, a frissítendő párokat és az eltávolítandó értékeket.diffarr-sync-lists
QUERIFYfunctionObjektumból épít lekérdezési karakterláncos URL-t.utility-globals
PROMISIFYfunctionA PROMISIFY(fn, a, b, c) meghív egy függvényt, amely utolsó argumentumként visszahívást vár, és promise-t ad vissza.utility-globals
ENCRYPTfunctionEgy értéket átlátszatlan tokenné alakít.encrypt-and-decrypt
DECRYPTfunctionBeolvas egy értéket egy ENCRYPT-tel készített tokenből.encrypt-and-decrypt
ENCRYPTREQfunctionTitkosít egy értéket a kérés user agentjével együtt (szigorú módban az IP-címével is).request-bound-tokens
DECRYPTREQfunctionBeolvas egy ENCRYPTREQ-kel létrehozott értéket; nem ad vissza semmit, ha a kérés nem egyezik.request-bound-tokens
LOCALIZEfunctionKiválasztja minden kérés nyelvét.localization
TRANSLATEfunctionEgy karakterlánc @(...) szövegeit lefordítja egy nyelvre.localization
TangularobjectA sablonmotor (Tangular.render()).tangular-templates
TaobjectA Tangular, a sablonmotor másik neve.template-files
ThelpersobjectA Tangular-sablonokban elérhető segédfüggvények.tangular-templates
TEMPLATEfunctionRenderel egy Tangular-sablont, amely egy szöveg, a templates mappa egy fájlja vagy egy URL, és promise-t ad vissza a szöveggel.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);
}