initialize MethodStatic

Invoke this method to initialize the hypermodeling package for use. You must await the result before using any of this package's APIs. Typically an application would invoke this after IModelApp.startup, e.g.,

 await IModelApp.startup();
 await HyperModeling.initialize();

Calling this method again after the first initialization behaves the same as calling HyperModeling.replaceConfiguration.

initialize(config?: HyperModelingConfig): Promise<void>

@note The hypermodeling package will be reset to uninitialized after IModelApp.shutdown is invoked.

@see HyperModeling.replaceConfiguration and HyperModeling.updateConfiguration to modify the configuration after initialization.

Parameter Type Description
config HyperModelingConfig  

Returns - Promise<void>

Defined in

Last Updated: 16 April, 2024