Skip to main content

Reference

The reference section is a complete lookup guide for every API in @digital-alchemy/core. Pages are organized by concern.

Application​

PageDescription
CreateApplicationAll CreateApplication options and the ApplicationDefinition API
Bootstrap OptionsAll BootstrapOptions fields, process exit codes, signal handling

Libraries​

PageDescription
CreateLibraryCreateLibrary options, depends vs optionalDepends
Dependency GraphbuildSortOrder, BAD_SORT, MISSING_DEPENDENCY
Module ExtensioncreateModule and ModuleExtension chainable API

Services​

PageDescription
Service FunctionsServiceFunction signature, wiring semantics
TServiceParamsAll TServiceParams properties, internal utilities
Object ReturnMethods, getters, live state
Function ReturnFactory and callable patterns
priorityInitWiring order within a module

Lifecycle​

PageDescription
OverviewLIFECYCLE_STAGES, stage reference, full sequence diagram
HooksAll 7 hook methods
Execution OrderPriority tiers, parallel vs serial, late registration

Configuration​

PageDescription
OverviewLOAD_PROJECT, TInjectedConfig, module scoping
TypesAll 6 config types with TypeScript mappings
SourcingEnv, argv, file loaders; merge order; custom loaders
Accessing ConfigTiming, required entries, source restriction

Builtins​

PageDescription
OverviewWhat builtins are; standalone exports
LoggerGetLogger, levels, targets, overrides
SchedulerTScheduler — all 5 methods
Event BusEventEmitter, typed events, error constants
Utilitiessleep, debounce, is, each, timing constants

Testing​

PageDescription
TestRunnerConstructor, all fluent builder methods
Module ReplacementsappendLibrary, appendService, replaceLibrary
Test LifecycleLifecycle stages in tests, setup, teardown
Configuration Overrides.configure(), PartialConfiguration, isolation