Overview
The @sodacore/core package is the framework of the application and is required for any and all applications you intend to build. It provides the autowire, dependency injection, and handles pretty much all of the features of the framework.
The core package provides a variety of providers and modules that are highlighted below.
Decorators
Decorators are used to provide metadata to the application, below are the core package's built-ins.
| Decorator | Description |
|---|---|
| Autoload | The autoload decorator can help dictate the order in which modules are autowired, helpful for use cases where you get race conditions. |
| Configure | The configure decorator adds additional user-defined meta data to a class. |
| Controller | The controller decorator is used to deal with threads that dispatch events back to the main thread. |
| Expose | The expose decorator is used by the threads and workers to define which methods must be passed to the thread or worker respectively. |
| Hook | The hook decorator allows you to add hook into framework events within any module within your platform. |
| Service | The service decorator will mark a class as a service and that it will follow the service workflow. |
| Task | The task decorator denotes a class as a task and therefore should be loaded as a task. |
| Thread | The thread decorator handles launching and offloading methods into a separate thread process. |
| Worker | The worker decorator handles launching and offloading methods into a separate worker process. |
Helpers
Helpers are just generic importable classes that provide additional functionality to the application, that don't require an instantianted class, i.e. singletons.
| Helper | Description |
|---|---|
| Utils | The utils (utilities) helper is used to provide a set of utility functions that are used throughout the application. |
Modules
Modules are where a lot of the main logic exists for the application.
| Module | Description |
|---|---|
| Application | The application module is the main module that is used to bootstrap the application. |
| Autowire | The autowire module is used to automatically load your files into the application and handle importing, etc. |
| Events | The events module is used to handle events and event listeners and dispatching hooks. |
| Runner | The runner module is used to handle the cron-tasks. |
| Services | The services are a module that provide a service to the application, like a HTTP server or TCP connection, these then should handle their own controllers and context objects to be dispatched to. |
| Thread | The thread module is actually the wrapper that wraps user-provided threads and handles their IPC and lifecycle. |
| Threads | The threads module is used to handle the creation, IPC and general management of threads. |
| Worker | The worker module is used to handle the creation, IPC and general management of workers. |
Providers
| Provider | Description |
|---|---|
| Logger | The logger is an extendable logging class that you can use to build your own logger, or you can build one from scratch. |
| TasksProvider | The tasks provider is used to handle calling manually defined tasks. |
| ThreadsProvider | The thread provider is a class that allows for dispatching tasks to threads. |