Class AxonCore

You can set one or many middlewares in global scope with this method.

Example

core.globalMiddleware(authMiddleware)
core.globalMiddleware([uploadMiddleware, userMiddleware])
Copy

Start listening to http incoming requests

Example

core.listen("0.0.0.0", 80)
// or
core.listen("0.0.0.0", {
     https: 443,
     http: 80
})
Copy

Loads a specified Axon plugin using the plugin loader.

Example

// this class must implements AxonPlugin type
class MyPlugin implements AxonPlugin {
     name = "plugin"
     version = "1.0.0"

     init(core) {}
}

core.loadPlugin(new MyPlugin())
Copy

loads created routes

Example

const router = Router(); // without prefix
const router2 = Router("/api/v1"); // with prefix

router.get('/', async (req, res) => {});

core.loadRoute(router);
Copy

unload routes based on entered parameters

Example

// this one unloads a route with path `/api/v1/user`.
core.unloadRoute({
    route: '/api/v1/user'
});

// this one unloads all  routes with method `GET`
core.unloadRoute({
    method: 'GET'
});

const userRouter = Router();

// this one unloads all routes of userRouter.
core.unloadRoute({
    router: userRouter
});

// this one unloads a route with path `/api/v1/user`, all routes with method `GET` and all routes of userRouter.
core.unloadRoute({
    route: '/api/v1/user',
    method: "GET",
    router: userRouter
})
Copy

unload all routes

Example

core.unloadRoutes();
Copy