Dox class
Constructors
Dox ()
factory
Properties
cache ↔ CacheManager
cache stores from config.cache, made on first use in each isolate.
Cache() uses it. replace it in tests.
getter/setter pair
config ↔ AppConfig
get app config
getter/setter pair
doxServices ↔ List <DoxService
list of services that need to run when
creating isolate
getter/setter pair
dtos → DtoRegistry
the DTOs of the app, from config.dtos. Empty before initialize .
no setter
hashCode → int
The hash code for this object.
no setter inherited
ioc ↔ IocContainer
global dox ioc containers
getter/setter pair
isolateId ↔ int
isolate Id
getter/setter pair
messages → MessageResolver
validation messages, from config.validationMessages.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
server → DoxServer
get dox http server
no setter
socketIo ↔ SocketIoServer?
Socket.IO server of this isolate, when config.socketIo is enabled.
getter/setter pair
storage ↔ DriveManager
storage disks from config.storage, made on first use in each
isolate. Storage() uses it. replace it in tests.
getter/setter pair
validator ↔ RequestValidator
checks DTOs and schemas for req.validate<T>() and controller
parameters.
getter/setter pair
websocket ↔ IDoxWebsocket ?
websocket
getter/setter pair
Methods
addService (DoxService service → void
add service that need to run on isolate spawn
addServices (List <DoxService services → void
####### functions need to run on isolate #######
add services that need to run on isolate spawn
checkAppKey ()
→ void
stop at startup when APP_KEY is missing in production.
without a key, cookies and other encrypted data use an empty
(predictable) key. outside production it only logs a warning.
initialize (AppConfig appConfig → void
initialize dox application
it load env and set config
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setWebsocket (IDoxWebsocket ws → void
set websocket
override
startServer ()
→ Future <void >
start dox server
startServices ()
→ Future <void >
start service registered to dox
this is internal core use only
your app do not need to call this function
toString ()
→ String
A string representation of this object.
inherited
totalIsolate (int value → void
override total isolate from config
default is one per CPU core
writeOpenApi (String dir → Future <List <File
write openapi.json and openapi.yaml of the app routes into dir.
bin/openapi.dart calls this for dox openapi:generate.
