ForgeΤεκμηρίωση
el

Τεκμηρίωση

Παγκόσμια ονόματα Total.js 5

Total.js 5 · total5@0.0.19 referenceglobals Εκτελέστηκε με το Total.js 5

Το Total.js 5 παρουσιάζει παγκόσμιες λειτουργίες και αντικείμενα για το routing, τις ενέργειες, την αποθήκευση, τα μηνύματα και τις εφαρμογές.

ΌνομαΕίδοςΤι κάνειΣυνταγή
ONfunctionΚαταχωρίζει έναν ακροατή για ένα γεγονός της εφαρμογής.events
ONCEfunctionΌπως το ON, αλλά ο ακροατής τρέχει μόνο για το πρώτο γεγονός.events
OFFfunctionΑφαιρεί έναν ακροατή που καταχωρίστηκε με ON.events
EMITfunctionΕκπέμπει ένα γεγονός με έως επτά ορίσματα.events
LOADfunctionΦορτώνει τα αρχεία του έργου (controllers, ορισμούς...)· το framework το καλεί για εσάς στην εκκίνηση.load-and-npminstall
LOADCONFIGfunctionΑναλύει ένα κείμενο στη μορφή config και το εφαρμόζει στο CONF.configuration-file
LOADRESOURCEfunctionΦορτώνει έναν πόρο (αρχείο μετάφρασης) από κείμενο ή από URL.localization
PAUSESERVERfunctionΘέτει σε παύση ή συνεχίζει τον διακομιστή με όνομα: όσο είναι σε παύση, τα αιτήματα παίρνουν σελίδα 503.pause-server
DEBUGbooleantrue σε λειτουργία debug, false σε λειτουργία release.release-mode-and-debugging
CONFobjectΗ ρύθμιση της εφαρμογής (το αρχείο config και οι προεπιλογές του).configuration-file
DEFobjectΠροεπιλεγμένοι χειριστές και ρυθμίσεις του framework (DEF.onMail, DEF.helpers, DEF.onCSRFcheck...).view-helpers-and-config
FobjectΤο αντικείμενο του framework. Το Total είναι το ίδιο αντικείμενο.utility-globals
TotalobjectΤο αντικείμενο του framework (ίδιο με το F). Το Total.run() ξεκινά την εφαρμογή.release-mode-and-debugging
MAINobjectΈνα κενό αντικείμενο που δημιουργεί το framework για τα δεδομένα της εφαρμογής σας.utility-globals
REPOobjectΈνα κενό αντικείμενο που δημιουργεί το framework για τα δικά σας δεδομένα.utility-globals
FUNCobjectΈνα κενό αντικείμενο που δημιουργεί το framework για τις δικές σας συναρτήσεις.utility-globals
TEMPobjectΈνα αντικείμενο για προσωρινά δεδομένα· το framework το αντικαθιστά κατά διαστήματα με ένα νέο κενό αντικείμενο.utility-globals
NOWobjectΗ τρέχουσα ημερομηνία, που ανανεώνεται από το framework μία φορά το λεπτό και από ορισμένες κλήσεις όπως το CACHE.utility-globals
EMPTYARRAYobjectΈνας παγωμένος κενός πίνακας, για να αποφεύγεται η δημιουργία νέων.utility-globals
EMPTYOBJECTobjectΈνα παγωμένο κενό αντικείμενο, για να αποφεύγεται η δημιουργία νέων.utility-globals
MODSobjectΟι φορτωμένες ενότητες του φακέλου modules/, ανά id.utility-globals
PLUGINSobjectΤα φορτωμένα πρόσθετα του φακέλου plugins/, ανά id.utility-globals
NOOPfunctionΜια συνάρτηση που δεν κάνει τίποτα.utility-globals
printfunctionΤο ίδιο με το console.log.utility-globals
REQUIREfunctionΌπως το require, αλλά ψάχνει και στον φάκελο node_modules της εφαρμογής και δέχεται ονόματα node:.utility-globals

Δρομολόγηση, ενέργειες και middleware

ΌνομαΕίδοςΤι κάνειΣυνταγή
ROUTEfunctionΔηλώνει μια διαδρομή (HTTP, SOCKET, FILE, API ή μια εφεδρική όπως το #404).http-methods
NEWACTIONfunctionΔηλώνει μια ενέργεια με την είσοδο, τα params, το query, την έξοδο και τα δικαιώματά της.actions-crud
NEWSCHEMAfunctionΟμαδοποιεί τις ενέργειες μιας οντότητας κάτω από ένα όνομα.schemas
ACTIONfunctionΕκτελεί μια ενέργεια από τον δικό σας κώδικα.calling-actions-from-code
EXECfunctionΗ ίδια συνάρτηση με το ACTION.calling-actions-from-code
NEWTRANSFORMfunctionΠροσθέτει ένα βήμα σε μια ονομασμένη αλυσίδα μετασχηματισμών.transforms
TRANSFORMfunctionΠερνά μια τιμή μέσα από μια αλυσίδα μετασχηματισμών.transforms
MIDDLEWAREfunctionΚαταχωρίζει ένα middleware για χρήση σε διαδρομές με #name.middleware
NEWMIDDLEWAREfunctionΗ ίδια συνάρτηση με το MIDDLEWARE.middleware
PROXYfunctionΠροωθεί τα αιτήματα κάτω από ένα πρόθεμα URL σε άλλον διακομιστή.proxy
CORSfunctionΟρίζει τις προελεύσεις που μπορούν να καλούν την εφαρμογή από έναν περιηγητή.cors
ErrorBuilderfunctionΗ κλάση που συλλέγει τα σφάλματα επικύρωσης.errors-and-audit
SUCCESSfunctionΕπιστρέφει το αντικείμενο που στέλνει το framework για μια επιτυχή λειτουργία ({ success: true, value: value }).errors-and-audit
ERRORfunctionΤο ERROR(name) επιστρέφει ένα callback που καταγράφει το σφάλμα που λαμβάνει με αυτό το όνομα· το ERROR() επιστρέφει το προεπιλεγμένο callback σφάλματος.errors-and-audit
UNAUTHORIZEDfunctionΤο UNAUTHORIZED($, ...permissions) απαντά 401 και επιστρέφει true όταν ο χρήστης δεν έχει καμία από τις άδειες· επιστρέφει false όταν έχει μία από αυτές ή είναι υπερδιαχειριστής.action-user-and-permissions
AUTHfunctionΠιστοποιεί κάθε αίτημα: μια συνάρτηση, ή οι επιλογές των ενσωματωμένων συνεδριών.sessions-with-built-in-auth
BLOCKEDfunctionΜετρά τις κλήσεις μιας διεύθυνσης IP και λέει πότε έφτασε το όριο.rate-limiting
AUDITfunctionΠροσθέτει μια εγγραφή ελέγχου (χρήστης, μήνυμα και τύπος) σε ένα αρχείο καταγραφής στο logs/.errors-and-audit

Δεδομένα και cache

ΌνομαΕίδοςΤι κάνειΣυνταγή
NOSQLfunctionΑνοίγει έναν πίνακα της ενσωματωμένης βάσης NoSQL.nosql-crud
DATAobjectΕίσοδος στον query builder ανεξάρτητη από τη βάση δεδομένων.data-api
DBfunctionΞεκινά ένα ερώτημα με τον query builder (DB().find('table').where(...).callback($))· το ερώτημα εκτελείται από τον driver που καταχωρίστηκε με NEWDB.query-builder-db
NEWDBfunctionΚαταχωρίζει έναν driver βάσης δεδομένων function(options, callback) για τον query builder: τον προεπιλεγμένο, ή έναν ονομασμένο με NEWDB('name', fn).query-builder-db
CACHEobjectΈνας χώρος αποθήκευσης στη μνήμη με λήξη.cache
FILECACHEfunctionΥπολογίζει ένα αποτέλεσμα μία φορά και το κρατά σε αρχείο για κάποιο διάστημα.filecache
MEMORIZEfunctionΈνα αντικείμενο JSON αποθηκευμένο στον δίσκο.memorize
FILESTORAGEfunctionΈνας χώρος αποθήκευσης για μεταφορτωμένα αρχεία.filestorage

Πελάτες HTTP, WebSocket και μηνυμάτων

ΌνομαΕίδοςΤι κάνειΣυνταγή
REQUESTfunctionΠελάτης HTTP χαμηλού επιπέδου.request-and-download
DOWNLOADfunctionΑποθηκεύει την απάντηση ενός URL σε αρχείο.request-and-download
RESTBuilderfunctionBuilder για κλήσεις σε άλλα HTTP API.restbuilder
AJAXfunctionΤο AJAX('METHOD /url/', data, callback) κάνει ένα αίτημα με την κεφαλίδα x-requested-with και επιστρέφει το αναλυμένο σώμα· επιστρέφει promise όταν δεν υπάρχει callback.ajax-requests
APIfunctionΚαλεί μια λειτουργία μιας εξωτερικής υπηρεσίας μέσω του driver της: API('service', 'operation', data).callback($).api-drivers
NEWAPIfunctionΚαταχωρίζει τον driver function(options, next) μιας υπηρεσίας για το API, με προαιρετική ρύθμιση.api-drivers
TotalAPIfunctionΚαλεί μια υπηρεσία της πλατφόρμας Total.js μέσω API('TAPI', name, model).remote-service-boundaries
WEBSOCKETCLIENTfunctionΈνας πελάτης WebSocket για την εφαρμογή σας.websocket-client
TMSCLIENTfunctionΈνας πελάτης του Total Messaging Service.tms
PUBLISHfunctionΣτέλνει ένα μήνυμα στους πελάτες TMS που έχουν εγγραφεί σε αυτό.tms
NEWPUBLISHfunctionΔηλώνει ένα μήνυμα που δημοσιεύει η εφαρμογή.tms
SUBSCRIBEfunctionΠροσθέτει έναν ακροατή για ένα μήνυμα που στέλνουν οι πελάτες στην εφαρμογή.tms
UNSUBSCRIBEfunctionΑφαιρεί τους ακροατές ενός μηνύματος TMS.tms
NEWSUBSCRIBEfunctionΔηλώνει ένα μήνυμα που λαμβάνει η εφαρμογή.tms
NEWCALLfunctionΔηλώνει μια συνάρτηση που μπορούν να καλούν οι πελάτες TMS.tms
OPENCLIENTfunctionΣυνδέεται στο OpenPlatform μέσω WebSocket για απομακρυσμένες κλήσεις, συμβάντα και κοινόχρηστες συνδέσεις.openclient-protocol
PROXYCLIENTfunctionΣυνδέεται με έναν PROXYSERVER μέσω WebSocket και απαντά στα αιτήματά του με έναν τοπικό διακομιστή (μια θύρα ή ip:port).proxy-tunnel
PROXYSERVERfunctionΜετατρέπει την εφαρμογή σε διακομιστή σήραγγας: τα αιτήματα HTTP ενός endpoint στέλνονται μέσω μιας διαδρομής WebSocket σε έναν PROXYCLIENT.proxy-tunnel
LDAPfunctionΣυνδέεται σε έναν διακομιστή LDAP (θύρα 389 εκτός αν το ldap.port λέει άλλο) και καλεί πίσω με το αποτέλεσμα.ldap-openldap
MAILfunctionΣτέλνει ένα email του οποίου το σώμα είναι μια προβολή.send-email
HTMLMAILfunctionΣτέλνει ένα email του οποίου το σώμα είναι μια συμβολοσειρά HTML.send-email
LOGMAILfunctionΣτέλνει ένα email το σώμα του οποίου είναι κείμενο τυπωμένο σε μπλοκ <pre> (περάστε το σώμα ως κείμενο).logmail
MailobjectΗ κλάση πίσω από την αποστολή email (SMTP).send-email
AIMODELfunctionΞεκινά ένα αίτημα προς ένα γλωσσικό μοντέλο που καταχωρίστηκε με NEWAIMODEL: AIMODEL('name').user('text').callback($.callback()).ai-models
AIPARSERfunctionΔημιουργεί έναν αναλυτή για τη ροή απάντησης ενός παρόχου AI (openai, claude...): το write() δέχεται κομμάτια και το end() επιστρέφει το περιεχόμενο, τη σκέψη και τις κλήσεις εργαλείων.ai-models
NEWAIMODELfunctionΚαταχωρίζει τον driver function(ai, done) ενός ή περισσότερων μοντέλων AI για το AIMODEL, με προαιρετική ρύθμιση.ai-models
PYPELINEfunctionΕκτελεί από την εφαρμογή ένα αρχείο Python του φακέλου pypelines/ (ή ενσωματωμένο κώδικα Python) και επικοινωνεί μαζί του με πλαίσια JSON πάνω από ένα socket.pypeline

Αρχεία, σύστημα και workers

ΌνομαΕίδοςΤι κάνειΣυνταγή
PATHobjectΒοηθοί που δημιουργούν διαδρομές στους φακέλους του έργου (PATH.root(), PATH.public(), PATH.tmp()...).file-download
MERGEfunctionΚαταχωρίζει ένα εικονικό αρχείο που αποτελείται από πολλά αρχεία, ελαχιστοποιημένο.minification
TOUCHfunctionΚαθαρίζει τις αποθηκευμένες ελαχιστοποιημένες, προσωρινές και μη βρεθείσες εγγραφές ενός URL, ή όλων.touch-static-cache
CLEANUPfunctionΚαταστρέφει μια ροή όταν τελειώσει.cleanup-streams
BACKUPfunctionΣυμπιέζει έναν κατάλογο σε ένα αρχείο.backup-restore-shell
RESTOREfunctionΑποσυμπιέζει ένα αρχείο που δημιουργήθηκε με BACKUP.backup-restore-shell
SHELLfunctionΕκτελεί μια εντολή shell στον φάκελο του έργου.backup-restore-shell
NPMINSTALLfunctionΕγκαθιστά ένα πακέτο npm στον φάκελο ενοτήτων της εφαρμογής.load-and-npminstall
IMPORTfunctionΚατεβάζει ένα αρχείο JavaScript από ένα URL και το φορτώνει.import-remote-module
ImageobjectΕπεξεργασία εικόνων με GraphicsMagick ή ImageMagick.images
NEWTHREADfunctionΞεκινά ένα worker thread.workers-and-threads
NEWFORKfunctionΞεκινά μια θυγατρική διεργασία.workers-and-threads
NEWTHREADPOOLfunctionΔημιουργεί μια ομάδα workers που οι εργασίες δανείζονται μία τη φορά.thread-pool
CRONfunctionΕκτελεί μια συνάρτηση βάσει προγράμματος.cron-jobs
setTimeout2functionΤο setTimeout με id: η κλήση του ξανά με το ίδιο id αντικαθιστά τον προηγούμενο χρονοδιακόπτη.debounce-timers
clearTimeout2functionΑκυρώνει έναν χρονοδιακόπτη που δημιουργήθηκε με setTimeout2.debounce-timers
FlowobjectΟ διαχειριστής των FlowStreams της εφαρμογής: Flow.load(schema), Flow.remove(id), Flow.instances και Flow.test() για ένα component.flowstream, flowstream-component-test
FlowStreamobjectΤο ίδιο αντικείμενο με το Flow.flowstream
NEWMACROfunctionΜεταγλωττίζει ένα macro από μια συμβολοσειρά.macros
NEWCOMPONENTfunctionΜεταγλωττίζει το HTML ενός component.native-components
COMPONENTATORfunctionΚατεβάζει ένα πακέτο Componentator στο public/ ως ui-<name>-<hash>.min.js και αποθηκεύει τη διεύθυνσή του στο F.repo[name].remote-service-boundaries

Βοηθητικά, πρότυπα και τοπική προσαρμογή

ΌνομαΕίδοςΤι κάνειΣυνταγή
UobjectΤο βοηθητικό αντικείμενο του framework (U.extend(), U.clone()...).utilities
UtilsobjectΤο ίδιο αντικείμενο με το U.utilities
UIDfunctionΔημιουργεί ένα σύντομο μοναδικό id ταξινομημένο κατά χρόνο.unique-ids-and-hashes
GUIDfunctionΔημιουργεί μια τυχαία συμβολοσειρά του δοσμένου μήκους.unique-ids-and-hashes
HASHfunctionΕπιστρέφει ένα γρήγορο αριθμητικό hash (όχι για κωδικούς πρόσβασης).unique-ids-and-hashes
CLONEfunctionΚάνει ένα βαθύ αντίγραφο ενός αντικειμένου.utility-globals
COPYfunctionΑντιγράφει τις ιδιότητες του πρώτου αντικειμένου στο δεύτερο και επιστρέφει το δεύτερο.utility-globals
DIFFARRfunctionΣυγκρίνει δύο πίνακες αντικειμένων ως προς μια ιδιότητα και επιστρέφει τα αντικείμενα προς προσθήκη, τα ζεύγη προς ενημέρωση και τις τιμές προς αφαίρεση.diffarr-sync-lists
QUERIFYfunctionΔημιουργεί ένα URL με συμβολοσειρά ερωτήματος από ένα αντικείμενο.utility-globals
PROMISIFYfunctionΤο PROMISIFY(fn, a, b, c) καλεί μια συνάρτηση που παίρνει callback ως τελευταίο όρισμα και επιστρέφει promise.utility-globals
ENCRYPTfunctionΜετατρέπει μια τιμή σε αδιαφανές διακριτικό.encrypt-and-decrypt
DECRYPTfunctionΔιαβάζει μια τιμή από ένα διακριτικό που δημιουργήθηκε με ENCRYPT.encrypt-and-decrypt
ENCRYPTREQfunctionΚρυπτογραφεί μια τιμή μαζί με τον user agent ενός αιτήματος (και τη διεύθυνση IP του σε αυστηρή λειτουργία).request-bound-tokens
DECRYPTREQfunctionΔιαβάζει μια τιμή που δημιουργήθηκε με ENCRYPTREQ· δεν επιστρέφει τίποτα όταν το αίτημα δεν ταιριάζει.request-bound-tokens
LOCALIZEfunctionΕπιλέγει τη γλώσσα κάθε αιτήματος.localization
TRANSLATEfunctionΜεταφράζει τα κείμενα @(...) μιας συμβολοσειράς σε μια γλώσσα.localization
TangularobjectΗ μηχανή προτύπων (Tangular.render()).tangular-templates
TaobjectΆλλο όνομα του Tangular, της μηχανής προτύπων.template-files
ThelpersobjectΟι βοηθητικές συναρτήσεις που είναι διαθέσιμες στα πρότυπα Tangular.tangular-templates
TEMPLATEfunctionΑποδίδει ένα πρότυπο Tangular που είναι κείμενο, αρχείο του φακέλου templates ή URL, και επιστρέφει promise με το κείμενο.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);
}