builder library
Classes
- BuildConfig
- Build-time configuration for generating and serving a Spry app.
- ErrorEntry
- Metadata for a discovered error file.
- GeneratedEntry
- A generated output event emitted by the build pipeline.
- HooksEntry
-
Metadata discovered from
hooks.dart. - MiddlewareEntry
- Metadata for a discovered middleware file.
- RouteEntry
- Metadata for a discovered route file.
- ScanEntry
- A scanner event emitted by the scanner.
Enums
- GeneratedEntryType
- Kinds of generated output emitted by the build pipeline.
- ScanEntryType
- Kinds of scan events emitted by the scanner.
Functions
-
generate(
Stream< ScanEntry> entries, BuildConfig config, {bool includeRuntime = true, bool includeOpenApi = true, bool includeClient = true}) → Stream<GeneratedEntry> - Generates typed output entries from streamed scan events.
-
loadConfig(
{String? configPath, Map< String, Object?> overrides = const {}}) → Future<BuildConfig> -
Loads
spry.config.dartand merges the suppliedoverrides. -
scan(
BuildConfig config) → Stream< ScanEntry> - Scans the project filesystem and emits typed scan events.
Exceptions / Errors
- LoadConfigException
-
Error thrown when loading
spry.config.dartfails. - RouteScanException
- Error thrown when route discovery or semantic validation finds invalid input.