Interface IFebby

The main interface representing the Febby application.

Hierarchy

IFebby

Implemented by

Febby

Index

Methods

bootstrap closeConnection closeDbConnection crud finalHandler loadDefaultMiddlewares loadOpenAPIConfigYAML middleware middlewares model models route router routes shutdown start

Methods

bootstrap

bootstrap(cb?: Function): Promise<void>
Initializes and boots up the Febby application.
Parameters
- Optional cb: Function
  
  Callback function to run after booting.
Returns Promise<void>
- Defined in src/types.ts:209

closeConnection

closeConnection(): Promise<void>
Closes the application's connection.

Returns Promise<void>
- Defined in src/types.ts:320

closeDbConnection

closeDbConnection(): Promise<void>
Closes the database connection used by the application.

Returns Promise<void>
- Defined in src/types.ts:315

crud

crud(path: string, config: ICrudConfig, model: any, router?: Router): Promise<void>
Configures CRUD operations for a specific path and model.
Parameters
- path: string
  
  The URL path for CRUD operations.
- config: ICrudConfig
  
  Configuration for CRUD operations.
- model: any
  
  The Mongoose model for CRUD operations.
- Optional router: Router
  
  Optional Express router to use for routes.
Returns Promise<void>
- Defined in src/types.ts:255

finalHandler

finalHandler(middleware: NextFunction): Promise<void>
Adds a final request handler middleware to the application.
Parameters
- middleware: NextFunction
  
  The final request handler middleware.
Returns Promise<void>
- Defined in src/types.ts:236

loadDefaultMiddlewares

loadDefaultMiddlewares(): Promise<void>
Loads the default middlewares for the Febby application.

Returns

A promise that resolves when the default middlewares are loaded.

Returns Promise<void>
- Defined in src/types.ts:340

loadOpenAPIConfigYAML

loadOpenAPIConfigYAML(path: string, options?: IOpenApiOptions): Promise<void>
Loads an OpenAPI specification from a YAML file and configures the application.

Returns

A promise that resolves when the configuration is loaded.
Parameters
- path: string
  
  The path to the OpenAPI YAML spec file.
- Optional options: IOpenApiOptions
  
  Options for controllers, middlewares, and validation.
Returns Promise<void>
- Defined in src/types.ts:330

middleware

middleware(middleware: NextFunction, router?: Router): Promise<void>
Adds a single middleware to an Express router.
Parameters
- middleware: NextFunction
  
  The middleware function.
- Optional router: Router
  
  Optional Express router to add the middleware to.
Returns Promise<void>
- Defined in src/types.ts:291

middlewares

middlewares(middlewares: NextFunction[], router?: Router): Promise<void>
Adds multiple middlewares to an Express router.
Parameters
- middlewares: NextFunction[]
  
  An array of middleware functions.
- Optional router: Router
  
  Optional Express router to add middlewares to.
Returns Promise<void>
- Defined in src/types.ts:283

model

model(name: string, schema: Schema<any, Model<any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}>): Promise<Model<Document<any, any, any>, {}, {}, {}, any>>
Creates a Mongoose model for a specific name and schema.

Returns

The created Mongoose model.
Parameters
- name: string
  
  The name of the model.
- schema: Schema<any, Model<any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}>
  
  The schema for the model.
Returns Promise<Model<Document<any, any, any>, {}, {}, {}, any>>
- Defined in src/types.ts:226

models

models(): Promise<{
[index: string]: mongoose.Model<mongoose.Document, {}>;
}>
Retrieves all registered Mongoose models.

Returns

An object containing all registered Mongoose models.

Returns Promise<{
[index: string]: mongoose.Model<mongoose.Document, {}>;
}>
- Defined in src/types.ts:243

route

route(routeConfig: IRouteConfig): Promise<void>
Registers a single route configuration with the application.
Parameters
- routeConfig: IRouteConfig
  
  A single route configuration.
Returns Promise<void>
- Defined in src/types.ts:305

router

router(url: string, router?: Router, options?: RouterOptions): Promise<Router>
Creates and configures an Express router for a specific URL path.

Returns

The created Express router.
Parameters
- url: string
  
  The URL path to create a router for.
- Optional router: Router
  
  Optional Express router instance.
- Optional options: RouterOptions
  
  Optional router options.
Returns Promise<Router>
- Defined in src/types.ts:271

routes

routes(routesConfig: IRouteConfig[]): Promise<void>
Registers multiple route configurations with the application.
Parameters
- routesConfig: IRouteConfig[]
  
  An array of route configurations.
Returns Promise<void>
- Defined in src/types.ts:298

shutdown

shutdown(): Promise<void>
Shuts down the Febby application.

Returns Promise<void>
- Defined in src/types.ts:310

start

start(): Promise<void>
Starts the Febby application.

Returns

A promise that resolves when the app is started.

Returns Promise<void>
- Defined in src/types.ts:216

Interface IFebby

Hierarchy

Implemented by

Index

Methods

Methods

bootstrap

Parameters

Optional cb: Function

Returns Promise<void>

closeConnection

Returns Promise<void>

closeDbConnection

Returns Promise<void>

crud

Parameters

path: string

config: ICrudConfig

model: any

Optional router: Router

Returns Promise<void>

finalHandler

Parameters

middleware: NextFunction

Returns Promise<void>

loadDefaultMiddlewares

Returns

Returns Promise<void>

loadOpenAPIConfigYAML

Returns

Parameters

path: string

Optional options: IOpenApiOptions

Returns Promise<void>

middleware

Parameters

middleware: NextFunction

Optional router: Router

Returns Promise<void>

middlewares

Parameters

middlewares: NextFunction[]

Optional router: Router

Returns Promise<void>

model

Returns

Parameters

name: string

schema: Schema<any, Model<any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}>

Returns Promise<Model<Document<any, any, any>, {}, {}, {}, any>>

models

Returns

Returns Promise<{ [index: string]: mongoose.Model<mongoose.Document, {}>; }>

route

Parameters

routeConfig: IRouteConfig

Returns Promise<void>

router

Returns

Parameters

url: string

Optional router: Router

Optional options: RouterOptions

Returns Promise<Router>

routes

Parameters

routesConfig: IRouteConfig[]

Returns Promise<void>

shutdown

Returns Promise<void>

start

Returns

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` cb: Function

`Optional` router: Router

`Optional` options: IOpenApiOptions

`Optional` router: Router

`Optional` router: Router

Returns Promise<{
[index: string]: mongoose.Model<mongoose.Document, {}>;
}>

`Optional` router: Router

`Optional` options: RouterOptions