Class AxonCore

Index

Constructors

Methods

clearGlobalMiddlewares close getConfig getContainer getServers globalMiddleware listen loadPlugin loadRoute registerDependencyFactory registerDependencyValue unloadRoute unloadRoutes

Constructors

constructor

new AxonCore(config?: AxonConfig): AxonCore
Parameters
- Optionalconfig: AxonConfig
Returns AxonCore
- Defined in core/AxonCore.ts:93

Methods

clearGlobalMiddlewares

clearGlobalMiddlewares(): void
Clears all the global middlewares

Returns void
- Defined in core/AxonCore.ts:339

close

close(server?: "http" | "https"): boolean
Closes the web servers
Parameters
- Optionalserver: "http" | "https"
  server to close
Returns boolean
Example
```
core.close() // closes both http and https servers
core.close("http") // closes only http server
core.close("https") // closes only https server
```
- Defined in core/AxonCore.ts:824

getConfig

getConfig(): AxonConfig
Returns the core config

Returns AxonConfig
core config
Example
```
const config = core.getConfig();
console.log(config);
```
- Defined in core/AxonCore.ts:871

getContainer

getContainer(): NeuronContainer
Get instance of dependency container that is using by Axon core.

Returns NeuronContainer
Dependency Container

Since
0.13.0
- Defined in core/AxonCore.ts:880

getServers

getServers(): {
    http: null
    | Server<typeof IncomingMessage, typeof ServerResponse>;
    https: null | Server<typeof IncomingMessage, typeof ServerResponse>;
}
Returns the server object

Returns {
http: null | Server<typeof IncomingMessage, typeof ServerResponse>;
https: null | Server<typeof IncomingMessage, typeof ServerResponse>;
}
server object
Example
```
const servers = core.getServers();
servers.http.on("request", () => {
    // something here
});
```
- Defined in core/AxonCore.ts:857

globalMiddleware

globalMiddleware(
    fn: Middleware | Middleware[],
    timeout?: number,
    critical?: boolean,
): Promise<void>
You can set one or many middlewares in global scope with this method.
Parameters
- fn: Middleware | Middleware[]
  middleware function or array of middleware functions
- Optionaltimeout: number
  timeout in milliseconds
- critical: boolean = false
  whether the middleware is critical (defaults to false)
Returns Promise<void>
Example
```
core.globalMiddleware(authMiddleware, 5000, true) // critical middleware with 5s timeout
core.globalMiddleware([uploadMiddleware, userMiddleware], 10000, false) // optional middlewares with 10s timeout
```
- Defined in core/AxonCore.ts:300

listen

listen(
    host?: string,
    port?: number | { http: number; https: number },
    callback?: (mode?: string) => void,
): void
Start listening to http incoming requests
Parameters
- host: string = '127.0.0.1'
  server host address
- port: number | { http: number; https: number } = 8000
  server port
- Optionalcallback: (mode?: string) => void
  callback a function to run after starting to listen
Returns void
Example
```
core.listen("0.0.0.0", 80)
// or
core.listen("0.0.0.0", {
     https: 443,
     http: 80
})
```
- Defined in core/AxonCore.ts:682

loadPlugin

loadPlugin(plugin: AxonPlugin): Promise<void>
Loads a specified Axon plugin using the plugin loader.
Parameters
- plugin: AxonPlugin
  The plugin to be loaded. It should be an instance of AxonPlugin.
Returns Promise<void>
Example
```
// this class must implements AxonPlugin type
class MyPlugin implements AxonPlugin {
     name = "plugin"
     version = "1.0.0"

     init(core) {}
}

core.loadPlugin(new MyPlugin())
```
- Defined in core/AxonCore.ts:133

loadRoute

loadRoute(router: AxonRouter): Promise<void>
loads created routes
Parameters
- router: AxonRouter
  instance of Router which routes set with it.
Returns Promise<void>
Example
```
const router = Router(); // without prefix
const router2 = Router("/api/v1"); // with prefix

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

core.loadRoute(router);
```
- Defined in core/AxonCore.ts:175

registerDependencyFactory

registerDependencyFactory<T>(
    name: string | string[],
    factory: () => T | Promise<T>,
    options?: { lifecycle?: Lifecycle },
): void
Register a factory function that creates the dependency (sync or async).

Default lifecycle of dependencies is singleton
Type Parameters
- T
Parameters
- name: string | string[]
  String, array of string or Function key for the dependency
- factory: () => T | Promise<T>
  Factory function or something that must run to return the instance of dependency
- Optionaloptions: { lifecycle?: Lifecycle }
  Some options for configuring the dependency
Returns void
Since
0.13.0
Example
```
core.registerDependencyFactory('db', () => new DB())
core.registerDependencyFactory('auth', async () => await AuthService.build())
```
- Defined in core/AxonCore.ts:283

registerDependencyValue

registerDependencyValue<T>(
    name: string | string[],
    value: T,
    options?: { lifecycle?: Lifecycle },
): void
Register a static value or instance (object, function, class instance).

Default lifecycle of dependencies is singleton
Type Parameters
- T
Parameters
- name: string | string[]
  String, array of string or Function key for the dependency
- value: T
  Function, object or instance to register as dependency value
- Optionaloptions: { lifecycle?: Lifecycle }
  Some options for configuring the dependency
Returns void
Since
0.13.0
Example
```
core.registerDependencyValue('logger', new Logger());
core.registerDependencyValue('config', { port: 3000 });
```
- Defined in core/AxonCore.ts:261

unloadRoute

unloadRoute(__namedParameters: UnloadRouteParams): Promise<void>

unload routes based on entered parameters

Parameters

__namedParameters: UnloadRouteParams

Returns Promise<void>

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
})

unloadRoutes

unloadRoutes(): Promise<void>
unload all routes

Returns Promise<void>
Example
```
core.unloadRoutes();
```
- Defined in core/AxonCore.ts:243

Class AxonCore

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AxonCore

Methods

clearGlobalMiddlewares

Returns void

close

Parameters

Returns boolean

Example

getConfig

Returns AxonConfig

Example

getContainer

Returns NeuronContainer

Since

getServers

Returns { http: null | Server<typeof IncomingMessage, typeof ServerResponse>; https: null | Server<typeof IncomingMessage, typeof ServerResponse>;}

Example

globalMiddleware

Parameters

Returns Promise<void>

Example

listen

Parameters

Returns void

Example

loadPlugin

Parameters

Returns Promise<void>

Example

loadRoute

Parameters

Returns Promise<void>

Example

registerDependencyFactory

Type Parameters

Parameters

Returns void

Since

Example

registerDependencyValue

Type Parameters

Parameters

Returns void

Since

Example

unloadRoute

Parameters

Returns Promise<void>

Example

unloadRoutes

Returns Promise<void>

Example

Settings

On This Page

Returns {
http: null | Server<typeof IncomingMessage, typeof ServerResponse>;
https: null | Server<typeof IncomingMessage, typeof ServerResponse>;
}