File

projects/wms-framework/src/lib/regionsframework/ModuleInfo.ts

Description

Information for a module

Index

Properties

Constructor

constructor(moduleName?: string, moduleType?: string)
Parameters :
Name Type Optional
moduleName string Yes
moduleType string Yes

Properties

DependsOn
Type : SimpleList<string>
Default value : new SimpleList<string>()

A list of module names that this module depends on

InitializationMode
Type : ModuleInitializationMode
Default value : ModuleInitializationMode.WhenAvailable

Determines if the given module will be initialized at module startup or on-demand

ModuleName
Type : string
Default value : null

Name of the module

ModuleType
Type : string
Default value : null

Module type class

Ref
Type : string
Default value : null

URL of the application module (may be null)

RuntimeTypeInfo
Type : RuntimeTypeInfo

The runtime type info of the module (may be null)

State
Default value : ModuleState.NotStarted

The current initialization state of the project

import { RuntimeTypeInfo, SimpleList } from '../baseframework';
import { ModuleInitializationMode } from './InitializationMode';

/**
 *  Possible initialization states  for a moudle
 *
 * @export
 * @enum {number}
 * @wEnum Microsoft.Practices.Prism.Modularity.ModuleState
 */
export enum ModuleState {
  NotStarted,
  Initializing,
  Initialized,
}

/**
 *  Information for a module
 *
 * @export
 * @class ModuleInfo
 * @wType Microsoft.Practices.Prism.Modularity.ModuleInfo
 */
export class ModuleInfo {
  /**
   * A list of module names that this module depends on
   *
   * @type {SimpleList<string>}
   * @memberof ModuleInfo
   */
  DependsOn: SimpleList<string> = new SimpleList<string>();

  /**
   * The current initialization state of the project
   *
   * @memberof ModuleInfo
   */
  State = ModuleState.NotStarted;

  /**
   *  Name of the module
   *
   * @type {string}
   * @memberof ModuleInfo
   */
  ModuleName: string = null;

  /**
   * Module type class
   *
   * @type {string}
   * @memberof ModuleInfo
   */
  ModuleType: string = null;

  /**
   * URL of the application module (may be null)
   *
   * @type {string}
   * @memberof ModuleInfo
   */
  Ref: string = null;

  /**
   *  Determines if the given module will be initialized at module startup or on-demand
   *
   * @type {ModuleInitializationMode}
   * @memberof ModuleInfo
   */
  InitializationMode: ModuleInitializationMode =
    ModuleInitializationMode.WhenAvailable;

  /**
   * The runtime type info of the module (may be null)
   *
   * @type {RuntimeTypeInfo}
   * @memberof ModuleInfo
   * @wIgnore
   */
  RuntimeTypeInfo: RuntimeTypeInfo;

  constructor(moduleName?: string, moduleType?: string) {
    this.ModuleName = moduleName;
    this.ModuleType = moduleType;
  }
}

result-matching ""

    No results matching ""