Interface JimpexEvents

A dictionary with the events emitted by the application and their payloads.

interface JimpexEvents {
    afterStart: EventPayload<Record<string, unknown>>;
    afterStartCallback: EventPayload<Record<string, unknown>>;
    afterStop: EventPayload<Record<string, unknown>>;
    beforeStart: EventPayload<Record<string, unknown>>;
    beforeStop: EventPayload<Record<string, unknown>>;
    routeAdded: EventPayload<{
        route: string;
    }>;
    start: EventPayload<Record<string, unknown>>;
}

Properties

afterStart: EventPayload<Record<string, unknown>>

Called after the controllers and middlewares have been mounted.

afterStartCallback: EventPayload<Record<string, unknown>>

Called after the onStart callback has been called.

afterStop: EventPayload<Record<string, unknown>>

Called after the server instance has been closed.

beforeStart: EventPayload<Record<string, unknown>>

Called right before creating the server and calling listen on it.

beforeStop: EventPayload<Record<string, unknown>>

Called before closing the server instance.

routeAdded: EventPayload<{
    route: string;
}>

Called every time a new route is mounted in the application.

Type declaration

  • route: string
start: EventPayload<Record<string, unknown>>

Called once the server confirmed that is listening.

Generated using TypeDoc