Edit

IModuleConfigurationBase interface

  • Reference
Package:
@microsoft/sp-module-interfaces

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This is the base interface for a script module's definition.

Properties

shouldNotPreload

If set to true, this module should not be preloaded when loading the component.
type

The type of the script block. "component" modules come from a component, "path" and "localizedPath" modules must be available on the paths provided in the "internalModuleBaseUrls" field.

Property Details

shouldNotPreload

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If set to true, this module should not be preloaded when loading the component.

shouldNotPreload?: boolean;

Property Value

boolean

Remarks

The most common case for setting this property to "true" is when a module is defined in a manifest, but is not required for the module referenced in "entryModuleId" to load. Modules may be defined that are loaded asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to false.

Usage: Instructs the module loader to not preload this module.

type

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The type of the script block. "component" modules come from a component, "path" and "localizedPath" modules must be available on the paths provided in the "internalModuleBaseUrls" field.

type: 'component' | 'path' | 'localizedPath';

Property Value

'component' | 'path' | 'localizedPath'

Remarks

Modules with the "path" type use the IPathModuleConfiguration interface.

Modules with the "component" type use the IComponentModuleConfiguration interface. Modules with the "localizedPath" type use the ILocalizedPathModuleConfiguration interface.

Supported values: "component", "path", "localizedPath"

Example: "localized"