Class Ignitor

Ignitor is used to instantiate an AdonisJS application in different known environments. It serves as the main entry point for creating and managing application processes.

Example

const ignitor = new Ignitor(new URL(import.meta.url))

// For HTTP server
await ignitor.httpServer().start()

// For CLI commands  
await ignitor.ace().handle(process.argv.slice(2))

// For tests
await ignitor.testRunner().run(() => {})

Index

Constructors

constructor

Methods

getApp createApp tap httpServer ace testRunner terminate

Constructors

constructor

new Ignitor(appRoot: URL, options?: IgnitorOptions): Ignitor
Creates a new Ignitor instance
Parameters
- appRoot: URL
  The root URL of the application
- options: IgnitorOptions = {}
  Configuration options for the ignitor
Returns Ignitor
- Defined in src/ignitor/main.ts:68

Methods

getApp

getApp(): undefined | ApplicationService
Get access to the application instance created by either the http server process or the ace process

Returns undefined | ApplicationService
- Defined in src/ignitor/main.ts:85

createApp

createApp(environment: AppEnvironments): ApplicationService
Create an instance of AdonisJS application
Parameters
- environment: AppEnvironments
  The environment in which to create the app (web, console, test, repl)
Returns ApplicationService
- Defined in src/ignitor/main.ts:94

tap

tap(callback: (app: ApplicationService) => void): this
Tap to access the application class instance.
Parameters
- callback: (app: ApplicationService) => void
  Callback function to execute when app is created
Returns this
- Defined in src/ignitor/main.ts:108

httpServer

httpServer(): HttpServerProcess
Get instance of the HTTPServerProcess

Returns HttpServerProcess
- Defined in src/ignitor/main.ts:116

ace

ace(): AceProcess
Get an instance of the AceProcess class

Returns AceProcess
- Defined in src/ignitor/main.ts:123

testRunner

testRunner(): TestRunnerProcess
Get an instance of the TestRunnerProcess class

Returns TestRunnerProcess
- Defined in src/ignitor/main.ts:130

terminate

terminate(): Promise<void>
Terminates the app by calling the "app.terminate" method

Returns Promise<void>
- Defined in src/ignitor/main.ts:138

Class Ignitor

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Ignitor

Methods

getApp

Returns undefined | ApplicationService

createApp

Parameters

Returns ApplicationService

tap

Parameters

Returns this

httpServer

Returns HttpServerProcess

ace

Returns AceProcess

testRunner

Returns TestRunnerProcess

terminate

Returns Promise<void>

Settings

On This Page