Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Plugins

Hierarchy

  • Initializer
  • Initializer
  • Initializer
  • Initializer
    • Plugins

Index

Constructors

constructor

  • Returns Plugins

Properties

Optional loadPriority

loadPriority: number

What order should this Initializer load at (Default: 1000, Actionhero core methods are < 1000)

name

name: string

The name of the Initializer.

Optional startPriority

startPriority: number

What order should this Initializer start at (Default: 1000, Actionhero core methods are < 1000)

Optional stopPriority

stopPriority: number

What order should this Initializer stop at (Default: 1000, Actionhero core methods are < 1000)

Methods

initialize

  • initialize(): Promise<void>

registerPlugin

  • Parameters

    Returns void

registerSettingsArray

  • registerSettingsArray(settingsList: SettingsListItem[], pluginName: string): Promise<void>
  • Parameters

    Returns Promise<void>

Optional start

  • start(config: ConfigInterface): Promise<void>
  • Method run as part of the start lifecycle of your server. Usually connects to remote servers or processes..

    Parameters

    • config: ConfigInterface

    Returns Promise<void>

stop

  • stop(): Promise<void>
  • Returns Promise<void>

validate

  • validate(): void

validatePlugin

  • Parameters

    Returns boolean

Generated using TypeDoc