For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /api/externals-loading-webpack-plugin.externalsloadingpluginoptions.md.
This is the dev preview website. Check out the document at lynxjs.org

Home > @lynx-js/externals-loading-webpack-plugin > ExternalsLoadingPluginOptions

ExternalsLoadingPluginOptions interface

The options of the ExternalsLoadingPlugin.

Signature:

export interface ExternalsLoadingPluginOptions 

Properties

Property

Modifiers

Type

Description

backgroundLayer

string

The name of the background layer.

externals

Record<string, ExternalValue>

Specify the externals to be loaded. The externals should be Lynx Bundles.

globalObject?

'lynx' | 'globalThis' | undefined

(Optional) This option indicates what global object will be used to mount the library.

In Lynx, the library will be mounted to lynx[Symbol.for("__LYNX_EXTERNAL_GLOBAL__")] by default.

If you have enabled share js context and want to reuse the library by mounting to the global object, you can set this option to 'globalThis'.

'lynx'

mainThreadLayer

string

The name of the main thread layer.

retries?

number | undefined

(Optional) The number of additional attempts when fetching the external bundle times out (response.code === -2).

timeout?

number | undefined

(Optional) The timeout in milliseconds for loading the externals.