Class HeadlessPluginHostRPC

The RPC handler for headless plugins.

Hierarchy (View Summary)

AbstractPluginHostRPC<HeadlessPluginManagerExtImpl, null, HeadlessExtInterfaces>
- HeadlessPluginHostRPC

Index

Constructors

Properties

apiFactory banner envExt loadContainerModule localizationExt pluginManager rpc

Methods

createAPIFactory createExtInterfaces createPluginHost getBackendPluginPath initContext initExtApi initialize isESMPlugin registerExtInterfaces terminate

Constructors

constructor

new HeadlessPluginHostRPC(): HeadlessPluginHostRPC
Returns HeadlessPluginHostRPC
Overrides AbstractPluginHostRPC.constructor
- Defined in plugin-ext-headless/src/hosted/node/plugin-host-headless-rpc.ts:41

Properties

`Protected`apiFactory

apiFactory: null

`Protected` `Readonly`banner

banner: string

`Protected` `Readonly`envExt

envExt: EnvExtImpl

`Protected` `Readonly`loadContainerModule

loadContainerModule: PluginContainerModuleLoader

`Protected` `Readonly`localizationExt

localizationExt: LocalizationExtImpl

`Protected` `Readonly`pluginManager

pluginManager: HeadlessPluginManagerExtImpl

`Protected` `Readonly`rpc

rpc: any

Methods

`Protected`createAPIFactory

createAPIFactory(_extInterfaces: HeadlessExtInterfaces): null
Parameters
- _extInterfaces: HeadlessExtInterfaces
Returns null
Overrides AbstractPluginHostRPC.createAPIFactory
- Defined in plugin-ext-headless/src/hosted/node/plugin-host-headless-rpc.ts:56

`Protected`createExtInterfaces

createExtInterfaces(): HeadlessExtInterfaces
Returns HeadlessExtInterfaces
Overrides AbstractPluginHostRPC.createExtInterfaces
- Defined in plugin-ext-headless/src/hosted/node/plugin-host-headless-rpc.ts:49

createPluginHost

createPluginHost(): PluginHost
Create the PluginHost that is required by my plugin manager ext interface to delegate critical behaviour such as loading and initializing plugins to me.

Returns PluginHost
Inherited from AbstractPluginHostRPC.createPluginHost
- Defined in plugin-ext/lib/hosted/node/plugin-host-rpc.d.ts:85

`Protected`getBackendPluginPath

getBackendPluginPath(pluginModel: PluginModel): undefined | string
Parameters
- pluginModel: PluginModel
Returns undefined | string
Overrides AbstractPluginHostRPC.getBackendPluginPath
- Defined in plugin-ext-headless/src/hosted/node/plugin-host-headless-rpc.ts:61

initContext

initContext(contextPath: string, plugin: Plugin): void
Parameters
- contextPath: string
- plugin: Plugin
Returns void
Inherited from AbstractPluginHostRPC.initContext
- Defined in plugin-ext/lib/hosted/node/plugin-host-rpc.d.ts:71

`Protected`initExtApi

initExtApi(extApi: ExtPluginApi): void
Initialize the end of the given provided extension API applicable to the current plugin host. Errors should be propagated to the caller.
Parameters
- extApi: ExtPluginApi
  the extension API to initialize, if appropriate
Returns void
Throws
if any error occurs in initializing the extension API
Overrides AbstractPluginHostRPC.initExtApi
- Defined in plugin-ext-headless/src/hosted/node/plugin-host-headless-rpc.ts:65

initialize

initialize(): void
Returns void
Inherited from AbstractPluginHostRPC.initialize
- Defined in plugin-ext/lib/hosted/node/plugin-host-rpc.d.ts:66

`Protected`isESMPlugin

isESMPlugin(plugin: Plugin): boolean
Determine whether a plugin should be loaded via ESM import() instead of CommonJS require(). Mirrors Node's own rules:
- .mjs is always ESM
- .cjs is always CJS
- any other extension falls back to the package.json type field
Parameters
- plugin: Plugin
Returns boolean
Inherited from AbstractPluginHostRPC.isESMPlugin
- Defined in plugin-ext/lib/hosted/node/plugin-host-rpc.d.ts:80

`Protected`registerExtInterfaces

registerExtInterfaces(extInterfaces: EXT): void
Parameters
- extInterfaces: EXT
Returns void
Inherited from AbstractPluginHostRPC.registerExtInterfaces
- Defined in plugin-ext/lib/hosted/node/plugin-host-rpc.d.ts:70

terminate

terminate(): Promise<void>
Returns Promise<void>
Inherited from AbstractPluginHostRPC.terminate
- Defined in plugin-ext/lib/hosted/node/plugin-host-rpc.d.ts:67