Application
The Application (App
) is the backbone of a Wind-Waker Server.
The Application will be responsible for:
- Load and register all the
Actions
. - Register Global
Pipes
. - Load Application configuration.
- Start listen for incoming request.
#
Creating a new Appimport {App} from 'wind-waker'
// Create a new wind-waker server by instance the App classconst app = new App();
// Start listen to incoming request on port 4000app.start(4000);
#
Loading ActionsThe App will load all files with the suffix .actions.ts
.
This way the Actions
will be available.
When the App receive a request for /getUsers
, it will execute the getUsers
Action.
Notice
If the Action don't exist the App will return a not found response with code 404.
#
Start the AppYour App
will start to listen for incoming requests once the app.start()
be executed successfully.
// By default the port will be 4000app.start();
// You can set the port you want your App listen forapp.start(5001);
// You can provide feedback when the App is up and running this way:app.start().then(() => console.log(`Wind-Waker is up!`))
Congratulations, you have your App up and running.
Now let's show how to register some Actions here