Skip to main content

@microde/microservice

The API reference is generated from the public TypeScript exports and their TSDoc comments.

  • Microservice coordinates installed modules.
  • MicroserviceContext defines the non-blocking requestStop() and panic() operations available to modules.
  • MicroserviceStopRequest describes an orderly shutdown request.
  • ModuleKind identifies passive and active module behavior.
  • MicroserviceState describes the observable lifecycle state.
  • MicroserviceExecutionResult reports the final outcome.
  • MicroserviceModule defines the shared lifecycle and declares passive or active behavior.
  • ModuleHandle and ModuleInstanceId identify exact named installations without exposing module objects.
  • port, provide, dependency, and reference declare provider contracts and relationship slots.
  • SetupContext resolves dependencies; RunContext resolves dependencies and references.
  • Microservice.install(name, factory) returns a stable opaque handle, and Microservice.bind(consumer, slotName, provider) targets one exact installed instance.

These linked pages are regenerated by pnpm docs:api and are intentionally not committed to Git.