robusta_runner library
Run and extends your application base on Riverpod, event-driven, and extensions.
Classes
- Configurator
- Support to settings runner
- ContainerOptions
- Riverpod provider container options Use it for sharing and enhancing settings.
- DefaultEventManager
- {@template: event_manager.default_event_manager} Default event manager implementing EventManager. {@endtemplate}
- DependenceExtension
- An interface represent for extensions need specific extensions to load.
- ErrorEvent
- Will dispatch when Runner.run() throw exceptions.
- Event
- Event is the base class for classes containing event data.
- EventExtension
- Event extension support adding system events, set event manager for provider instance to aware it.
- EventManager
- Event manager interface Implements by classes help to manage events.
- EventManagerAware
- An interface implements by classes aware event manager.
-
EventStore<
E extends Event> -
Store EventListener and its priority of events type
E
. - Extension
- Extension interface for extensible, implementing classes will extend runner by adding features to it like boots, container overrides, container observers.
- ImplementingCallbackExtension
- An extension providing callback implementation feature for runner providers.
- LoggerAware
- An interface implements by classes aware loggable.
- RunEvent
- Will dispatch when Runner.run() called, this event will be dispatched after boot.
- Runner
- Runner class creates an instance to run your application, with this runner your app will be easy to scale, extend and maintain.
Extensions
- ImplementingCallbackExtensionConfigurator on Configurator
- Dart extension of Configurator help to settings ImplementingCallbackExtension.
Properties
-
eventManagerProvider
→ Provider<
EventManager> -
Event manager provider
final
-
loggerProvider
→ Provider<
Logger> -
Logger provider
final
Typedefs
-
Bootable
= FutureOr<
void> Function(ProviderContainer) - Bootable type, will be call when call Runner.run, it only run exact one time.
- BootDefinition = void Function(Bootable , {int priority})
- Define boot will be run with priority given uses to ordering boots, higher priority will be run first.
- DefineBoot = void Function(BootDefinition )
- Callback function uses to define boots via BootDefinition.
- DefineImplementingCallback = void Function(ImplementingCallbackDefinition )
- Uses to add/define callbacks via ImplementingCallbackDefinition.
-
EventConfigurator
= FutureOr<
void> Function(EventManager, ProviderContainer) - Uses to add/define event listeners to EventManager given.
-
EventListener<
E extends Event> = FutureOr< void> Function(E) - A callable will be call when
-
ImplementingCallback<
T> = void Function(T, ProviderContainer) -
Callback function will be call when instances of Riverpod providers
implementing
T
type. -
ImplementingCallbackDefinition
= void Function<
T>(ImplementingCallback< T> ) - Helper to help define/add implementing callback.
Exceptions / Errors
- RunnerException
- Collects exceptions throw by Runner.