events library
Events library for ormed.
This library exports all event types and the EventBus infrastructure.
Usage
import 'package:ormed/events.dart';
// Subscribe to events
final unsubscribe = EventBus.instance.on<ModelCreatedEvent>((event) {
print('Created: ${event.model}');
});
// Emit events
EventBus.instance.emit(
MigrationStartedEvent(
migrationId: 'm_20250101000000_create_users_table',
migrationName: 'create_users_table',
direction: MigrationDirection.up,
index: 1,
total: 1,
),
);
// Cleanup
unsubscribe();
Classes
- ConnectionClosed
- Fired when a connection is closed.
- ConnectionEstablished
- Fired when a new database connection is established.
- ConnectionEvent
- Base class for all connection-scoped events.
- ConnectionFailed
- Fired when connection fails.
- ConnectionStarted
- Fired when connecting to a database starts.
- Event
- Base class for all events in the system.
- EventBus
- A type-safe event bus implementing the publish/subscribe pattern.
- MigrationBatchCompletedEvent
- Event emitted when a migration batch completes.
- MigrationBatchStartedEvent
- Event emitted when a migration batch starts.
- MigrationCompletedEvent
- Event emitted when a single migration completes.
- MigrationEvent
- Base class for migration events.
- MigrationFailedEvent
- Event emitted when a migration fails.
- MigrationStartedEvent
- Event emitted when a single migration starts.
- ModelCreatedEvent
- Event emitted after a model is created in the database.
- ModelCreatingEvent
- Event emitted before a model is created in the database.
- ModelDeletedEvent
- Event emitted after a model is deleted from the database.
- ModelDeletingEvent
- Event emitted before a model is deleted from the database.
- ModelEvent
- Base class for model lifecycle events.
- ModelForceDeletedEvent
- Event emitted when a model is permanently deleted (force delete).
- ModelReplicatingEvent
- Event emitted when a model is being replicated.
- ModelRestoredEvent
- Event emitted after a model is restored from soft delete.
- ModelRestoringEvent
- Event emitted before a model is restored from soft delete.
- ModelRetrievedEvent
- Event emitted when a model is retrieved from the database.
- ModelSavedEvent
- Event emitted after a model is saved (create or update).
- ModelSavingEvent
- Event emitted before a model is saved (create or update).
- ModelTrashedEvent
- Event emitted when a soft-deleted model is trashed.
- ModelUpdatedEvent
- Event emitted after a model is updated in the database.
- ModelUpdatingEvent
- Event emitted before a model is updated in the database.
- OnCreated
- Convenience annotation for model created events.
- OnCreating
- Convenience annotation for model creating events.
- OnDeleted
- Convenience annotation for model deleted events.
- OnDeleting
- Convenience annotation for model deleting events.
- OnEvent
- Annotation to mark a method as an event handler.
- OnForceDeleted
- Convenience annotation for model force-deleted events.
- OnReplicating
- Convenience annotation for model replicating events.
- OnRestored
- Convenience annotation for model restored events.
- OnRestoring
- Convenience annotation for model restoring events.
- OnRetrieved
- Convenience annotation for model retrieved events.
- OnSaved
- Convenience annotation for model saved events.
- OnSaving
- Convenience annotation for model saving events.
- OnTrashed
- Convenience annotation for model trashed events.
- OnUpdated
- Convenience annotation for model updated events.
- OnUpdating
- Convenience annotation for model updating events.
- QueryExecuted
- Fired after every query executes.
- SeederCompletedEvent
- Event emitted when a single seeder completes.
- SeederEvent
- Base class for seeder events.
- SeederFailedEvent
- Event emitted when a seeder fails.
- SeederStartedEvent
- Event emitted when a single seeder starts.
- SeedingCompletedEvent
- Event emitted when seeding completes.
- SeedingStartedEvent
- Event emitted when seeding starts.
- TransactionBeginning
- Fired when a transaction begins.
- TransactionCommitted
- Fired after a transaction commits successfully.
- TransactionCommitting
- Fired when a transaction is about to commit.
- TransactionRolledBack
- Fired after a transaction rolls back.
Enums
- MigrationDirection
- Directions supported by a migration lifecycle.
Mixins
- CancellableEvent
- Mixin for events that can be cancelled.
-
ResultEvent<
T> - Mixin for events that carry a result/response.
Typedefs
-
EventListener<
T extends Event> = void Function(T event) - Callback type for event listeners.