ForgeDocumentație
ro

Documentație

Numele global al Total.js 5

Total.js 5 · total5@0.0.19 referenceglobals Executată cu Total.js 5

Total.js 5 expune funcții și obiecte globale pentru routing, acțiuni, stocare, mesaje și utilități de aplicare.

NumeGenCe faceRețetă
ONfunctionÎnregistrează un ascultător pentru un eveniment al aplicației.events
ONCEfunctionCa ON, dar ascultătorul rulează doar pentru primul eveniment.events
OFFfunctionElimină un ascultător înregistrat cu ON.events
EMITfunctionEmite un eveniment cu până la șapte argumente.events
LOADfunctionÎncarcă fișierele proiectului (controllere, definiții...); framework-ul îl apelează pentru tine la pornire.load-and-npminstall
LOADCONFIGfunctionAnalizează un text în formatul config și îl aplică la CONF.configuration-file
LOADRESOURCEfunctionÎncarcă o resursă (un fișier de traducere) dintr-un text sau dintr-un URL.localization
PAUSESERVERfunctionPune pe pauză sau reia serverul după nume: cât timp este pe pauză, cererile primesc o pagină 503.pause-server
DEBUGbooleantrue în modul debug, false în modul release.release-mode-and-debugging
CONFobjectConfigurația aplicației (fișierul config și valorile sale implicite).configuration-file
DEFobjectHandlerele și setările implicite ale framework-ului (DEF.onMail, DEF.helpers, DEF.onCSRFcheck...).view-helpers-and-config
FobjectObiectul framework-ului. Total este același obiect.utility-globals
TotalobjectObiectul framework-ului (la fel ca F). Total.run() pornește aplicația.release-mode-and-debugging
MAINobjectUn obiect gol pe care framework-ul îl creează pentru datele aplicației tale.utility-globals
REPOobjectUn obiect gol pe care framework-ul îl creează pentru propriile tale date.utility-globals
FUNCobjectUn obiect gol pe care framework-ul îl creează pentru propriile tale funcții.utility-globals
TEMPobjectUn obiect pentru date temporare; framework-ul îl înlocuiește din când în când cu un obiect gol nou.utility-globals
NOWobjectData curentă, reîmprospătată de framework o dată pe minut și de unele apeluri precum CACHE.utility-globals
EMPTYARRAYobjectUn array gol înghețat, pentru a evita crearea altora noi.utility-globals
EMPTYOBJECTobjectUn obiect gol înghețat, pentru a evita crearea altora noi.utility-globals
MODSobjectModulele încărcate din folderul modules/, după id.utility-globals
PLUGINSobjectPlugin-urile încărcate din folderul plugins/, după id.utility-globals
NOOPfunctionO funcție care nu face nimic.utility-globals
printfunctionLa fel ca console.log.utility-globals
REQUIREfunctionCa require, dar caută și în folderul node_modules al aplicației și acceptă nume node:.utility-globals

Rutare, acțiuni și middleware

NumeGenCe faceRețetă
ROUTEfunctionDeclară o rută (HTTP, SOCKET, FILE, API sau una de rezervă precum #404).http-methods
NEWACTIONfunctionDeclară o acțiune cu intrarea, params, query, ieșirea și permisiunile ei.actions-crud
NEWSCHEMAfunctionGrupează acțiunile unei entități sub un nume.schemas
ACTIONfunctionRulează o acțiune din propriul tău cod.calling-actions-from-code
EXECfunctionAceeași funcție ca ACTION.calling-actions-from-code
NEWTRANSFORMfunctionAdaugă un pas într-un lanț numit de transformări.transforms
TRANSFORMfunctionTrece o valoare printr-un lanț de transformări.transforms
MIDDLEWAREfunctionÎnregistrează un middleware de folosit în rute cu #name.middleware
NEWMIDDLEWAREfunctionAceeași funcție ca MIDDLEWARE.middleware
PROXYfunctionRedirecționează cererile de sub un prefix de URL către alt server.proxy
CORSfunctionSetează originile care pot apela aplicația dintr-un browser.cors
ErrorBuilderfunctionClasa care colectează erorile de validare.errors-and-audit
SUCCESSfunctionReturnează obiectul pe care framework-ul îl trimite pentru o operație reușită ({ success: true, value: value }).errors-and-audit
ERRORfunctionERROR(name) returnează un callback care înregistrează eroarea primită sub acel nume; ERROR() returnează callback-ul de eroare implicit.errors-and-audit
UNAUTHORIZEDfunctionUNAUTHORIZED($, ...permissions) răspunde 401 și returnează true când utilizatorul nu are niciuna dintre permisiuni; returnează false când are una dintre ele sau este super administrator.action-user-and-permissions
AUTHfunctionAutentifică fiecare cerere: o funcție sau opțiunile sesiunilor încorporate.sessions-with-built-in-auth
BLOCKEDfunctionNumără apelurile unei adrese IP și spune când a atins limita.rate-limiting
AUDITfunctionAdaugă o intrare de audit (utilizator, mesaj și tip) într-un fișier de jurnal din logs/.errors-and-audit

Date și cache

NumeGenCe faceRețetă
NOSQLfunctionDeschide un tabel al bazei de date NoSQL încorporate.nosql-crud
DATAobjectIntrare independentă de baza de date în query builder.data-api
DBfunctionPornește o interogare cu query builder-ul (DB().find('table').where(...).callback($)); interogarea este rulată de driverul înregistrat cu NEWDB.query-builder-db
NEWDBfunctionÎnregistrează un driver de bază de date function(options, callback) pentru query builder: cel implicit sau unul numit cu NEWDB('name', fn).query-builder-db
CACHEobjectUn depozit în memorie cu expirare.cache
FILECACHEfunctionCalculează un rezultat o dată și îl păstrează într-un fișier o vreme.filecache
MEMORIZEfunctionUn obiect JSON salvat pe disc.memorize
FILESTORAGEfunctionUn depozit pentru fișierele încărcate.filestorage

Clienți HTTP, WebSocket și de mesagerie

NumeGenCe faceRețetă
REQUESTfunctionClient HTTP de nivel scăzut.request-and-download
DOWNLOADfunctionSalvează răspunsul unui URL într-un fișier.request-and-download
RESTBuilderfunctionBuilder pentru apeluri către alte API-uri HTTP.restbuilder
AJAXfunctionAJAX('METHOD /url/', data, callback) face o cerere cu antetul x-requested-with și returnează corpul analizat; returnează un promise când nu există callback.ajax-requests
APIfunctionApelează o operație a unui serviciu extern prin driverul său: API('service', 'operation', data).callback($).api-drivers
NEWAPIfunctionÎnregistrează driverul function(options, next) al unui serviciu pentru API, cu o configurație opțională.api-drivers
TotalAPIfunctionApelează un serviciu al platformei Total.js prin API('TAPI', name, model).remote-service-boundaries
WEBSOCKETCLIENTfunctionUn client WebSocket pentru aplicația ta.websocket-client
TMSCLIENTfunctionUn client al Total Messaging Service.tms
PUBLISHfunctionTrimite un mesaj clienților TMS abonați la el.tms
NEWPUBLISHfunctionDeclară un mesaj pe care aplicația îl publică.tms
SUBSCRIBEfunctionAdaugă un ascultător pentru un mesaj pe care clienții îl trimit aplicației.tms
UNSUBSCRIBEfunctionElimină ascultătorii unui mesaj TMS.tms
NEWSUBSCRIBEfunctionDeclară un mesaj pe care aplicația îl primește.tms
NEWCALLfunctionDeclară o funcție pe care clienții TMS o pot apela.tms
OPENCLIENTfunctionSe conectează la OpenPlatform prin WebSocket pentru apeluri la distanță, evenimente și conexiuni partajate.openclient-protocol
PROXYCLIENTfunctionSe conectează la un PROXYSERVER prin WebSocket și răspunde cererilor lui cu un server local (un port sau ip:port).proxy-tunnel
PROXYSERVERfunctionTransformă aplicația într-un server de tunel: cererile HTTP ale unui endpoint sunt trimise printr-o rută WebSocket către un PROXYCLIENT.proxy-tunnel
LDAPfunctionSe conectează la un server LDAP (portul 389, dacă ldap.port nu spune altceva) și apelează înapoi cu rezultatul.ldap-openldap
MAILfunctionTrimite un e-mail al cărui corp este o vizualizare.send-email
HTMLMAILfunctionTrimite un e-mail al cărui corp este un șir HTML.send-email
LOGMAILfunctionTrimite un e-mail al cărui corp este un text afișat într-un bloc <pre> (trimite corpul ca text).logmail
MailobjectClasa din spatele trimiterii de e-mail (SMTP).send-email
AIMODELfunctionPornește o cerere către un model de limbaj înregistrat cu NEWAIMODEL: AIMODEL('name').user('text').callback($.callback()).ai-models
AIPARSERfunctionCreează un parser pentru răspunsul în flux al unui furnizor de IA (openai, claude...): write() primește bucăți, iar end() returnează conținutul, raționamentul și apelurile de instrumente.ai-models
NEWAIMODELfunctionÎnregistrează driverul function(ai, done) al unuia sau mai multor modele de IA pentru AIMODEL, cu o configurație opțională.ai-models
PYPELINEfunctionRulează din aplicație un fișier Python din folderul pypelines/ (sau cod Python inline) și comunică cu el prin cadre JSON pe un socket.pypeline

Fișiere, sistem și workeri

NumeGenCe faceRețetă
PATHobjectHelperi care construiesc căi în folderele proiectului (PATH.root(), PATH.public(), PATH.tmp()...).file-download
MERGEfunctionÎnregistrează un fișier virtual făcut din mai multe fișiere, minificat.minification
TOUCHfunctionȘterge intrările din cache minificate, temporare și negăsite ale unui URL sau ale tuturor.touch-static-cache
CLEANUPfunctionDistruge un stream când s-a terminat.cleanup-streams
BACKUPfunctionÎmpachetează un director într-un singur fișier.backup-restore-shell
RESTOREfunctionDespachetează un fișier creat cu BACKUP.backup-restore-shell
SHELLfunctionRulează o comandă shell în folderul proiectului.backup-restore-shell
NPMINSTALLfunctionInstalează un pachet npm în folderul de module al aplicației.load-and-npminstall
IMPORTfunctionDescarcă un fișier JavaScript de la un URL și îl încarcă.import-remote-module
ImageobjectProcesarea imaginilor cu GraphicsMagick sau ImageMagick.images
NEWTHREADfunctionPornește un worker thread.workers-and-threads
NEWFORKfunctionPornește un proces copil.workers-and-threads
NEWTHREADPOOLfunctionCreează un grup de workeri pe care sarcinile îi împrumută pe rând.thread-pool
CRONfunctionRulează o funcție după un program.cron-jobs
setTimeout2functionsetTimeout cu un id: apelarea din nou cu același id înlocuiește temporizatorul anterior.debounce-timers
clearTimeout2functionAnulează un temporizator creat cu setTimeout2.debounce-timers
FlowObiectulManagerul fluxurilor de aplicație: Flow.load(schema), Flow.remove(id), Flow.instances și Flow.test() pentru un singur component.Florirea, Testarea componentelor flowstream
FlowStreamobjectAcelași obiect ca Flow.flowstream
NEWMACROfunctionCompilează o macro dintr-un șir.macros
NEWCOMPONENTfunctionCompilează HTML-ul unei componente.native-components
COMPONENTATORfunctionDescarcă un bundle Componentator în public/ ca ui-<name>-<hash>.min.js și salvează adresa în F.repo[name].remote-service-boundaries

Utilitare, șabloane și localizare

NumeGenCe faceRețetă
UobjectObiectul utilitar al framework-ului (U.extend(), U.clone()...).utilities
UtilsobjectAcelași obiect ca U.utilities
UIDfunctionCreează un id unic scurt sortat după timp.unique-ids-and-hashes
GUIDfunctionCreează un șir aleatoriu de lungimea dată.unique-ids-and-hashes
HASHfunctionReturnează un hash numeric rapid (nu pentru parole).unique-ids-and-hashes
CLONEfunctionFace o copie profundă a unui obiect.utility-globals
COPYfunctionCopiază proprietățile primului obiect în al doilea și returnează al doilea.utility-globals
DIFFARRfunctionCompară două array-uri de obiecte după o proprietate și returnează obiectele de adăugat, perechile de actualizat și valorile de eliminat.diffarr-sync-lists
QUERIFYfunctionConstruiește un URL cu șir de interogare dintr-un obiect.utility-globals
PROMISIFYfunctionPROMISIFY(fn, a, b, c) apelează o funcție care primește un callback ca ultim argument și returnează un promise.utility-globals
ENCRYPTfunctionTransformă o valoare într-un token opac.encrypt-and-decrypt
DECRYPTfunctionCitește o valoare dintr-un token creat cu ENCRYPT.encrypt-and-decrypt
ENCRYPTREQfunctionCriptează o valoare împreună cu user agent-ul unei cereri (și adresa ei IP în modul strict).request-bound-tokens
DECRYPTREQfunctionCitește o valoare creată cu ENCRYPTREQ; nu returnează nimic când cererea nu se potrivește.request-bound-tokens
LOCALIZEfunctionAlege limba fiecărei cereri.localization
TRANSLATEfunctionTraduce textele @(...) ale unui șir într-o limbă.localization
TangularobjectMotorul de șabloane (Tangular.render()).tangular-templates
TaobjectAlt nume pentru Tangular, motorul de șabloane.template-files
ThelpersobjectFuncțiile helper disponibile în șabloanele Tangular.tangular-templates
TEMPLATEfunctionRandează un șablon Tangular care este un text, un fișier din folderul templates sau un URL, și returnează un promise cu textul.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);
}