@hexa-framework/common
v1.0.1
Published
Shared interfaces and types for Hexa Framework ecosystem
Maintainers
Readme
@hexa/common
Shared interfaces and types for the Hexa Framework ecosystem.
Installation
npm install @hexa/commonUsage
import {
IRepository,
IDatabaseAdapter,
ITransport,
IPlugin,
IEventBus
} from '@hexa/common';Interfaces
Database Adapters
IDatabaseAdapter- Base interface for all database adaptersDatabaseAdapterConfig- Configuration options
Repository
IRepository- Generic repository interfaceIBaseEntity- Base entity typePaginationResult- Pagination responseQueryOptions- Query parameters
Transports
ITransport- Base interface for all transportsRouteDefinition- Route configurationTransportOptions- Transport configuration
Plugins
IPlugin- Base interface for all pluginsPluginConfig- Plugin configurationPluginMetadata- Plugin information
Events
IEventBus- Event bus interfaceIDomainEvent- Domain event structureEventHandler- Event handler type
Other
ILogger- Logging interfaceICache- Caching interfaceApiResponse- Standard API response
