Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IProfileManager<T>

Type parameters

Hierarchy

  • IProfileManager

Index

Properties

Optional loadCounter

loadCounter: Map<string, number>

Map of which profile types have been loaded so far, to avoid circular profile loads Used internally by profile manager classes

Optional logger

logger: Logger

The logger object to use in the profile manager. Normally the imperative logger, but can be any arbitrary log4js logger.

memberof

IProfileManager

Optional productDisplayName

productDisplayName: string

Product display name of CLI

memberof

IProfileManager

profileRootDirectory

profileRootDirectory: string

The profiles directory (normally obtained from the Imperative config). The profile root directory contains a list of type directories, within each will be the profiles of that type and the meta file. The meta file for a type contains the default specifications and the profile type configuration document. Use the "initialize" API method on the Profile Manager to create the appropriate structure based on your configuration documents.

memberof

IProfileManager

type

type: string

The profile type for this manager - the configuration document for the type can either be supplied on the "typeConfigurations" property on this object OR the mananger will attempt to extract it from the profile root directory type meta file. If the type configuration cannot be located, an exception will be thrown.

memberof

IProfileManager

Optional typeConfigurations

typeConfigurations: T[]

Contains all profile type configuration documents - used to obtain the schema for the profile type passed on the profile manager and for dependency loading of profiles of other types.

If this parameter is NOT supplied to the constructor of the Profile Manager, the manager will attempt to read the configurations from each of the profile type meta files when the object is being instaitiated. If it fails to locate a configuration for the profile type specified, manager creation will fail. You can either supply the configurations to the constructor OR execute the "initialize" static API to create all type directories and their meta configuration files.

memberof

IProfileManager

Generated using TypeDoc