@univerjs/rpc v0.4.2 • Docs

Class: UniverRPCMainThreadPlugin

This plugin is used to register the RPC services on the main thread. It is also responsible for booting up the Web Worker instance of Univer.

Extends

Plugin

Constructors

new UniverRPCMainThreadPlugin()

new UniverRPCMainThreadPlugin(
   _config, 
   _injector, 
   _configService): UniverRPCMainThreadPlugin

Parameters

Parameter	Type	Default value
`_config`	`Partial`<`IUniverRPCMainThreadConfig`>	`defaultPluginMainThreadConfig`
`_injector`	`Injector`	`undefined`
`_configService`	`IConfigService`	`undefined`

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	-	`Plugin`.`_disposed`	packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`_injector`	`readonly`	`Injector`	`undefined`	-	`Plugin`.`_injector`	packages/rpc/src/plugin.ts:53 (opens in a new tab)
`pluginName`	`static`	`string`	`'UNIVER_RPC_MAIN_THREAD_PLUGIN'`	`Plugin`.`pluginName`	-	packages/rpc/src/plugin.ts:47 (opens in a new tab)
`type`	`static`	`UniverInstanceType`	`UniverInstanceType.UNIVER_UNKNOWN`	-	`Plugin`.`type`	packages/core/src/services/plugin/plugin.ts:35 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Overrides

Plugin.dispose

Defined in

packages/rpc/src/plugin.ts:63 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

packages/core/src/services/plugin/plugin.ts:59 (opens in a new tab)

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

packages/core/src/services/plugin/plugin.ts:55 (opens in a new tab)

onReady()

onReady(): void

Returns

void

Inherited from

Plugin.onReady

Defined in

packages/core/src/services/plugin/plugin.ts:43 (opens in a new tab)

onRendered()

onRendered(): void

Returns

void

Inherited from

Plugin.onRendered

Defined in

packages/core/src/services/plugin/plugin.ts:47 (opens in a new tab)

onStarting()

onStarting(): void

Returns

void

Overrides

Plugin.onStarting

Defined in

packages/rpc/src/plugin.ts:72 (opens in a new tab)

onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

packages/core/src/services/plugin/plugin.ts:51 (opens in a new tab)

Remotesyncprimaryservice Univerrpcworkerthreadplugin