Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RoleRegistration

Role registration information. Use this when your module provides a service which should support being turned on and off at runtime.

Hierarchy

Index

Properties

Methods

Properties

identifier

identifier: string

The identifier that will be matched when interpreting command line role enablements.

instance

instance: any

The instance of the module being registered. This should be this for the caller in most cases, as it should be called from an Alterior module's altOnInit() method.

name

name: string

The human readable name for this role.

summary

summary: string

A short (one sentence) summary which may be shown in command line help output and other places.

Methods

start

  • start(): Promise<void>
  • Start services associated with this role. For instance, an HTTP server module would start it's HTTP server.

    Returns Promise<void>

stop

  • stop(): Promise<void>

Generated using TypeDoc