Numele global al Total.js 5
Total.js 5 expune funcții și obiecte globale pentru routing, acțiuni, stocare, mesaje și utilități de aplicare.
| Nume | Gen | Ce face | Rețetă |
|---|---|---|---|
ON | function | Înregistrează un ascultător pentru un eveniment al aplicației. | events |
ONCE | function | Ca ON, dar ascultătorul rulează doar pentru primul eveniment. | events |
OFF | function | Elimină un ascultător înregistrat cu ON. | events |
EMIT | function | Emite un eveniment cu până la șapte argumente. | events |
LOAD | function | Încarcă fișierele proiectului (controllere, definiții...); framework-ul îl apelează pentru tine la pornire. | load-and-npminstall |
LOADCONFIG | function | Analizează un text în formatul config și îl aplică la CONF. | configuration-file |
LOADRESOURCE | function | Încarcă o resursă (un fișier de traducere) dintr-un text sau dintr-un URL. | localization |
PAUSESERVER | function | Pune pe pauză sau reia serverul după nume: cât timp este pe pauză, cererile primesc o pagină 503. | pause-server |
DEBUG | boolean | true în modul debug, false în modul release. | release-mode-and-debugging |
CONF | object | Configurația aplicației (fișierul config și valorile sale implicite). | configuration-file |
DEF | object | Handlerele și setările implicite ale framework-ului (DEF.onMail, DEF.helpers, DEF.onCSRFcheck...). | view-helpers-and-config |
F | object | Obiectul framework-ului. Total este același obiect. | utility-globals |
Total | object | Obiectul framework-ului (la fel ca F). Total.run() pornește aplicația. | release-mode-and-debugging |
MAIN | object | Un obiect gol pe care framework-ul îl creează pentru datele aplicației tale. | utility-globals |
REPO | object | Un obiect gol pe care framework-ul îl creează pentru propriile tale date. | utility-globals |
FUNC | object | Un obiect gol pe care framework-ul îl creează pentru propriile tale funcții. | utility-globals |
TEMP | object | Un obiect pentru date temporare; framework-ul îl înlocuiește din când în când cu un obiect gol nou. | utility-globals |
NOW | object | Data curentă, reîmprospătată de framework o dată pe minut și de unele apeluri precum CACHE. | utility-globals |
EMPTYARRAY | object | Un array gol înghețat, pentru a evita crearea altora noi. | utility-globals |
EMPTYOBJECT | object | Un obiect gol înghețat, pentru a evita crearea altora noi. | utility-globals |
MODS | object | Modulele încărcate din folderul modules/, după id. | utility-globals |
PLUGINS | object | Plugin-urile încărcate din folderul plugins/, după id. | utility-globals |
NOOP | function | O funcție care nu face nimic. | utility-globals |
print | function | La fel ca console.log. | utility-globals |
REQUIRE | function | Ca require, dar caută și în folderul node_modules al aplicației și acceptă nume node:. | utility-globals |
Rutare, acțiuni și middleware
| Nume | Gen | Ce face | Rețetă |
|---|---|---|---|
ROUTE | function | Declară o rută (HTTP, SOCKET, FILE, API sau una de rezervă precum #404). | http-methods |
NEWACTION | function | Declară o acțiune cu intrarea, params, query, ieșirea și permisiunile ei. | actions-crud |
NEWSCHEMA | function | Grupează acțiunile unei entități sub un nume. | schemas |
ACTION | function | Rulează o acțiune din propriul tău cod. | calling-actions-from-code |
EXEC | function | Aceeași funcție ca ACTION. | calling-actions-from-code |
NEWTRANSFORM | function | Adaugă un pas într-un lanț numit de transformări. | transforms |
TRANSFORM | function | Trece o valoare printr-un lanț de transformări. | transforms |
MIDDLEWARE | function | Înregistrează un middleware de folosit în rute cu #name. | middleware |
NEWMIDDLEWARE | function | Aceeași funcție ca MIDDLEWARE. | middleware |
PROXY | function | Redirecționează cererile de sub un prefix de URL către alt server. | proxy |
CORS | function | Setează originile care pot apela aplicația dintr-un browser. | cors |
ErrorBuilder | function | Clasa care colectează erorile de validare. | errors-and-audit |
SUCCESS | function | Returnează obiectul pe care framework-ul îl trimite pentru o operație reușită ({ success: true, value: value }). | errors-and-audit |
ERROR | function | ERROR(name) returnează un callback care înregistrează eroarea primită sub acel nume; ERROR() returnează callback-ul de eroare implicit. | errors-and-audit |
UNAUTHORIZED | function | UNAUTHORIZED($, ...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 |
AUTH | function | Autentifică fiecare cerere: o funcție sau opțiunile sesiunilor încorporate. | sessions-with-built-in-auth |
BLOCKED | function | Numără apelurile unei adrese IP și spune când a atins limita. | rate-limiting |
AUDIT | function | Adaugă o intrare de audit (utilizator, mesaj și tip) într-un fișier de jurnal din logs/. | errors-and-audit |
Date și cache
| Nume | Gen | Ce face | Rețetă |
|---|---|---|---|
NOSQL | function | Deschide un tabel al bazei de date NoSQL încorporate. | nosql-crud |
DATA | object | Intrare independentă de baza de date în query builder. | data-api |
DB | function | Pornește o interogare cu query builder-ul (DB().find('table').where(...).callback($)); interogarea este rulată de driverul înregistrat cu NEWDB. | query-builder-db |
NEWDB | function | Î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 |
CACHE | object | Un depozit în memorie cu expirare. | cache |
FILECACHE | function | Calculează un rezultat o dată și îl păstrează într-un fișier o vreme. | filecache |
MEMORIZE | function | Un obiect JSON salvat pe disc. | memorize |
FILESTORAGE | function | Un depozit pentru fișierele încărcate. | filestorage |
Clienți HTTP, WebSocket și de mesagerie
| Nume | Gen | Ce face | Rețetă |
|---|---|---|---|
REQUEST | function | Client HTTP de nivel scăzut. | request-and-download |
DOWNLOAD | function | Salvează răspunsul unui URL într-un fișier. | request-and-download |
RESTBuilder | function | Builder pentru apeluri către alte API-uri HTTP. | restbuilder |
AJAX | function | AJAX('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 |
API | function | Apelează o operație a unui serviciu extern prin driverul său: API('service', 'operation', data).callback($). | api-drivers |
NEWAPI | function | Înregistrează driverul function(options, next) al unui serviciu pentru API, cu o configurație opțională. | api-drivers |
TotalAPI | function | Apelează un serviciu al platformei Total.js prin API('TAPI', name, model). | remote-service-boundaries |
WEBSOCKETCLIENT | function | Un client WebSocket pentru aplicația ta. | websocket-client |
TMSCLIENT | function | Un client al Total Messaging Service. | tms |
PUBLISH | function | Trimite un mesaj clienților TMS abonați la el. | tms |
NEWPUBLISH | function | Declară un mesaj pe care aplicația îl publică. | tms |
SUBSCRIBE | function | Adaugă un ascultător pentru un mesaj pe care clienții îl trimit aplicației. | tms |
UNSUBSCRIBE | function | Elimină ascultătorii unui mesaj TMS. | tms |
NEWSUBSCRIBE | function | Declară un mesaj pe care aplicația îl primește. | tms |
NEWCALL | function | Declară o funcție pe care clienții TMS o pot apela. | tms |
OPENCLIENT | function | Se conectează la OpenPlatform prin WebSocket pentru apeluri la distanță, evenimente și conexiuni partajate. | openclient-protocol |
PROXYCLIENT | function | Se conectează la un PROXYSERVER prin WebSocket și răspunde cererilor lui cu un server local (un port sau ip:port). | proxy-tunnel |
PROXYSERVER | function | Transformă aplicația într-un server de tunel: cererile HTTP ale unui endpoint sunt trimise printr-o rută WebSocket către un PROXYCLIENT. | proxy-tunnel |
LDAP | function | Se conectează la un server LDAP (portul 389, dacă ldap.port nu spune altceva) și apelează înapoi cu rezultatul. | ldap-openldap |
MAIL | function | Trimite un e-mail al cărui corp este o vizualizare. | send-email |
HTMLMAIL | function | Trimite un e-mail al cărui corp este un șir HTML. | send-email |
LOGMAIL | function | Trimite un e-mail al cărui corp este un text afișat într-un bloc <pre> (trimite corpul ca text). | logmail |
Mail | object | Clasa din spatele trimiterii de e-mail (SMTP). | send-email |
AIMODEL | function | Pornește o cerere către un model de limbaj înregistrat cu NEWAIMODEL: AIMODEL('name').user('text').callback($.callback()). | ai-models |
AIPARSER | function | Creează 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 |
NEWAIMODEL | function | Înregistrează driverul function(ai, done) al unuia sau mai multor modele de IA pentru AIMODEL, cu o configurație opțională. | ai-models |
PYPELINE | function | Rulează 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
| Nume | Gen | Ce face | Rețetă |
|---|---|---|---|
PATH | object | Helperi care construiesc căi în folderele proiectului (PATH.root(), PATH.public(), PATH.tmp()...). | file-download |
MERGE | function | Înregistrează un fișier virtual făcut din mai multe fișiere, minificat. | minification |
TOUCH | function | Șterge intrările din cache minificate, temporare și negăsite ale unui URL sau ale tuturor. | touch-static-cache |
CLEANUP | function | Distruge un stream când s-a terminat. | cleanup-streams |
BACKUP | function | Împachetează un director într-un singur fișier. | backup-restore-shell |
RESTORE | function | Despachetează un fișier creat cu BACKUP. | backup-restore-shell |
SHELL | function | Rulează o comandă shell în folderul proiectului. | backup-restore-shell |
NPMINSTALL | function | Instalează un pachet npm în folderul de module al aplicației. | load-and-npminstall |
IMPORT | function | Descarcă un fișier JavaScript de la un URL și îl încarcă. | import-remote-module |
Image | object | Procesarea imaginilor cu GraphicsMagick sau ImageMagick. | images |
NEWTHREAD | function | Pornește un worker thread. | workers-and-threads |
NEWFORK | function | Pornește un proces copil. | workers-and-threads |
NEWTHREADPOOL | function | Creează un grup de workeri pe care sarcinile îi împrumută pe rând. | thread-pool |
CRON | function | Rulează o funcție după un program. | cron-jobs |
setTimeout2 | function | setTimeout cu un id: apelarea din nou cu același id înlocuiește temporizatorul anterior. | debounce-timers |
clearTimeout2 | function | Anulează un temporizator creat cu setTimeout2. | debounce-timers |
Flow | Obiectul | Managerul fluxurilor de aplicație: Flow.load(schema), Flow.remove(id), Flow.instances și Flow.test() pentru un singur component. | Florirea, Testarea componentelor flowstream |
FlowStream | object | Același obiect ca Flow. | flowstream |
NEWMACRO | function | Compilează o macro dintr-un șir. | macros |
NEWCOMPONENT | function | Compilează HTML-ul unei componente. | native-components |
COMPONENTATOR | function | Descarcă 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
| Nume | Gen | Ce face | Rețetă |
|---|---|---|---|
U | object | Obiectul utilitar al framework-ului (U.extend(), U.clone()...). | utilities |
Utils | object | Același obiect ca U. | utilities |
UID | function | Creează un id unic scurt sortat după timp. | unique-ids-and-hashes |
GUID | function | Creează un șir aleatoriu de lungimea dată. | unique-ids-and-hashes |
HASH | function | Returnează un hash numeric rapid (nu pentru parole). | unique-ids-and-hashes |
CLONE | function | Face o copie profundă a unui obiect. | utility-globals |
COPY | function | Copiază proprietățile primului obiect în al doilea și returnează al doilea. | utility-globals |
DIFFARR | function | Compară două array-uri de obiecte după o proprietate și returnează obiectele de adăugat, perechile de actualizat și valorile de eliminat. | diffarr-sync-lists |
QUERIFY | function | Construiește un URL cu șir de interogare dintr-un obiect. | utility-globals |
PROMISIFY | function | PROMISIFY(fn, a, b, c) apelează o funcție care primește un callback ca ultim argument și returnează un promise. | utility-globals |
ENCRYPT | function | Transformă o valoare într-un token opac. | encrypt-and-decrypt |
DECRYPT | function | Citește o valoare dintr-un token creat cu ENCRYPT. | encrypt-and-decrypt |
ENCRYPTREQ | function | Criptează o valoare împreună cu user agent-ul unei cereri (și adresa ei IP în modul strict). | request-bound-tokens |
DECRYPTREQ | function | Citește o valoare creată cu ENCRYPTREQ; nu returnează nimic când cererea nu se potrivește. | request-bound-tokens |
LOCALIZE | function | Alege limba fiecărei cereri. | localization |
TRANSLATE | function | Traduce textele @(...) ale unui șir într-o limbă. | localization |
Tangular | object | Motorul de șabloane (Tangular.render()). | tangular-templates |
Ta | object | Alt nume pentru Tangular, motorul de șabloane. | template-files |
Thelpers | object | Funcțiile helper disponibile în șabloanele Tangular. | tangular-templates |
TEMPLATE | function | Randează un șablon Tangular care este un text, un fișier din folderul templates sau un URL, și returnează un promise cu textul. | template-files |
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);
}