App
App is the entry point of your application. It is a wrapper around the provider and provides a way to register routers.
Usage
Create an app with the createApp
function. This function takes a config object with the following properties:
globalPrefix
- A prefix that will be used for all routes.provider
- A provider that will be used to create a store.routers
- An array with routers.logger
- A consola config that will be used to update options of the logger.env
- A dotenv config that will be used to load environment variables.plugins
- An array of plugins that will be used to extend the app.
ts
import { createApp } from 'nixle';
import { fastifyProvider } from '@nixle/fastify';
import { usersRouter } from './usersRouter';
export const app = createApp({
globalPrefix: '/api',
provider: fastifyProvider(),
routers: [usersRouter],
logger: {
level: 3,
},
env: {
path: '.env',
},
});
Returns
The createApp
function returns an object with the following properties:
app
- An instance of the app.events
- An object with the following properties:on
- A function that takes an event name and a handler function.emit
- A function that takes an event name and an event data.