Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RoleState

Hierarchy

Index

Properties

class

class: any

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.

running

running: boolean

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>

stop

  • stop(): Promise<void>

Generated using TypeDoc