Class: CanonicalModelService
Makaio Framework / services-core / CanonicalModelService
Class: CanonicalModelService
Section titled “Class: CanonicalModelService”Defined in: ../../../packages/services/core/src/canonical-model/canonical-model-service.ts:30
Service that exposes framework canonical-model resolution via bus RPC.
Wires CanonicalModelResolver dependencies to adapter-subsystem and
model-registry bus subjects and registers the canonicalModel.resolve handler.
Extends
Section titled “Extends”BaseService
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CanonicalModelService(
bus?):CanonicalModelService
Defined in: ../../../packages/services/core/src/canonical-model/canonical-model-service.ts:35
Creates a new CanonicalModelService instance.
Parameters
Section titled “Parameters”IMakaioBus = MakaioBus
Bus instance for request/event handling
Returns
Section titled “Returns”CanonicalModelService
Overrides
Section titled “Overrides”BaseService.constructor
Properties
Section titled “Properties”
protectedreadonlybus:IMakaioBus
Defined in: ../../../packages/services/base/src/base-service.ts:39
Bus instance used for registering handlers
Inherited from
Section titled “Inherited from”BaseService.bus
Accessors
Section titled “Accessors”initialized
Section titled “initialized”Get Signature
Section titled “Get Signature”get initialized():
boolean
Defined in: ../../../packages/services/base/src/base-service.ts:47
Whether the service has been successfully initialized.
Returns true after init() completes and before destroy() is called.
Returns
Section titled “Returns”boolean
true if initialized, false otherwise
Inherited from
Section titled “Inherited from”BaseService.initialized
Methods
Section titled “Methods”addCleanup()
Section titled “addCleanup()”
protectedaddCleanup(fn):void
Defined in: ../../../packages/services/base/src/base-service.ts:143
Enqueue an arbitrary cleanup function to be called on destroy().
Use for non-handler resources (timers, external subscriptions, etc.).
Parameters
Section titled “Parameters”() => void | Promise<void>
Function to invoke during teardown
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”BaseService.addCleanup
destroy()
Section titled “destroy()”destroy():
Promise<void>
Defined in: ../../../packages/services/base/src/base-service.ts:89
Destroy the service and unsubscribe all registered handlers.
Calls the optional onDestroy() hook before running cleanups, then
resets the initialized flag. Safe to call multiple times (idempotent).
Returns
Section titled “Returns”Promise<void>
Promise that resolves after teardown completes
Inherited from
Section titled “Inherited from”BaseService.destroy
init()
Section titled “init()”init():
Promise<void>
Defined in: ../../../packages/services/base/src/base-service.ts:57
Initialize the service.
Delegates to onInit() once; subsequent calls are no-ops (idempotent).
Returns
Section titled “Returns”Promise<void>
Promise that resolves when initialization is complete
Inherited from
Section titled “Inherited from”BaseService.init
onDestroy()?
Section titled “onDestroy()?”
protectedoptionalonDestroy():void|Promise<void>
Defined in: ../../../packages/services/base/src/base-service.ts:163
Optional service teardown hook.
Called by destroy() before automatic handler unsubscription.
Implement only when there are resources beyond bus handlers to clean up
(e.g., stopping trackers, clearing maps, releasing external handles).
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”BaseService.onDestroy
onInit()
Section titled “onInit()”
protectedonInit():Promise<void>
Defined in: ../../../packages/services/core/src/canonical-model/canonical-model-service.ts:42
Registers the canonical model resolution handler on the bus.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseService.onInit
registerHandler()
Section titled “registerHandler()”
protectedregisterHandler<S>(subject,handler):void
Defined in: ../../../packages/services/base/src/base-service.ts:129
Register a bus handler and enqueue its unsubscribe function for teardown.
Equivalent to this._cleanups.push(this.bus.on(subject, handler)).
Type Parameters
Section titled “Type Parameters”S extends SubjectDefinition
Parameters
Section titled “Parameters”subject
Section titled “subject”S
The subject definition to listen on
handler
Section titled “handler”HandlerForSubjectDefinition<S>
Handler function for the subject
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”BaseService.registerHandler