Type alias InstallServiceOptions

InstallServiceOptions: { configuration?: Record<string, any>; dependencies?: Record<string, string>; development?: boolean; legacy?: boolean; setup?: boolean }

Options for installing the service.

See installService.

Type declaration

  • Optional configuration?: Record<string, any>

    An object mapping configuration option names to values.

    See also getServiceConfiguration.

  • Optional dependencies?: Record<string, string>

    An object mapping dependency aliases to mount points.

    See also getServiceDependencies.

  • Optional development?: boolean

    Whether the service should be installed in development mode.

    See also setServiceDevelopmentMode.

    Default: false

  • Optional legacy?: boolean

    Whether the service should be installed in legacy compatibility mode

    This overrides the engines option in the service manifest (if any).

    Default: false

  • Optional setup?: boolean

    Whether the "setup" script should be executed.

    Default: true

Generated using TypeDoc