Events in the Ecosystem
Naming Convention
| 1 | namespace:event |
| 2 | namespace:area:event |
The namespace always corresponds to the responsible xPart – dotenv:loaded belongs to
@xpulse/dotenv, config:loaded belongs to @xpulse/config etc.
Known Events
@xpulse/dotenv
| Event |
Payload |
Description |
dotenv:loaded |
{ env, files, override } |
.env files have been loaded |
@xpulse/config
| Event |
Payload |
Description |
config:loaded |
{ name, type, env, files } |
Configuration has been loaded |
@xpulse/app *(planned)*
| Event |
Payload |
Description |
app:ready |
{ env, uptime, types } |
App fully started |
app:stopping |
{ signal } |
App is shutting down |
app:stopped |
{ uptime, exitCode } |
App has exited |
@xpulse/cli
| Event |
Payload |
Description |
cli:command |
{ name, args } |
CLI command has been parsed |
cli:help |
{ commands: [] } |
Help output is being assembled |
cli:done |
{ name, exitCode } |
Command has been executed |
@xpulse/http *(planned)*
| Event |
Payload |
Description |
http:request |
{ method, path, ip } |
Incoming request |
http:response |
{ status, ms } |
Response sent |