Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IEngine

Hierarchy

  • IEngine

Index

Properties

Methods

Properties

commandIDs

commandIDs: string[]

commands

commands: ICachedCommand[]

config

config: ICLIConfig

plugins

plugins: IPlugin[]

rootCommands

rootCommands: ICachedCommand[]

rootTopics

rootTopics: ITopic[]

topics

topics: ITopic[]

Methods

findCommand

findTopic

  • findTopic(id: string, must: true): ITopic
  • findTopic(id: string, must?: undefined | true | false): ITopic | undefined

  • Parameters

    • id: string
    • must: true

    Returns ITopic

  • Parameters

    • id: string
    • Optional must: undefined | true | false

    Returns ITopic | undefined

load

  • load(root: string): Promise<void>

  • Parameters

    • root: string

    Returns Promise<void>

runHook

  • runHook<T>(event: string, opts: T): Promise<void>

  • Type parameters

    • T: __type

    Parameters

    • event: string
    • opts: T

    Returns Promise<void>

Generated using TypeDoc