Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "launch"

Index

Variables

Functions

Variables

Const pkg

pkg: any = Object.freeze(JSON.parse(fs.readFileSync(path.join(__dirname, "..", "package.json"), "utf8")))

The contents of package.json

Functions

ConfigureNconf

  • ConfigureNconf(nconf: Provider, defaults?: any): Provider
  • Configures nconf instance.

    Parameters

    • nconf: Provider

      Nconf instance.

    • Default value defaults: any = defaultConfiguration

      Default config for nconf.

    Returns Provider

Main

  • Main(nconf?: Provider, sequelize?: ISequalize, logger?: ILogger): Promise<void>
  • This is the main entrypoint for the application. It will be called from the "bin/face-command-server" script. It can be called from outside this package to start the server elsewhere. Calling this function will setup the application, connect to the database, read configuration, etc.

    async

    Parameters

    • Optional nconf: Provider

      An existing nconf.Provider to provide the application configuration.

    • Optional sequelize: ISequalize
    • Optional logger: ILogger

      An existing winston Logger to use for logging. To disabling set to null.

    Returns Promise<void>

    • A promise that will resolve when the application has started.

Generated using TypeDoc