Skip to main content

Interface: ExtensionRegisterState<Init>

An object that the register method can use to detect unmount and access the configuration for extension dependencies

Extends

Type Parameters

Init

Properties

getDependency()

getDependency: <Dependency>(dep) => LexicalExtensionDependency<Dependency>

Get the configuration of a dependency by extension (must be a direct dependency of this extension)

Type Parameters

Dependency extends AnyLexicalExtension

Parameters

dep: Dependency

Returns

LexicalExtensionDependency<Dependency>

Defined in

types.ts:113


getDirectDependentNames()

getDirectDependentNames: () => ReadonlySet<string>

Get the names of any direct dependents of this Extension, typically only used for error messages.

Returns

ReadonlySet<string>

Inherited from

Omit.getDirectDependentNames

Defined in

types.ts:87


getInitResult()

getInitResult: () => Init

The result of the init function

Returns

Init

Defined in

types.ts:119


getPeer()

getPeer: <Dependency>(name) => undefined | LexicalExtensionDependency<Dependency>

Get the result of a peerDependency by name, if it exists (must be a peerDependency of this extension)

Type Parameters

Dependency extends AnyLexicalExtension = never

Parameters

name: Dependency["name"]

Returns

undefined | LexicalExtensionDependency<Dependency>

Defined in

types.ts:106


getPeerNameSet()

getPeerNameSet: () => ReadonlySet<string>

Get the names of all peer dependencies of this Extension, even if they do not exist in the builder, typically only used for devtools.

Returns

ReadonlySet<string>

Inherited from

Omit.getPeerNameSet

Defined in

types.ts:93


signal

signal: AbortSignal

An AbortSignal that is aborted when the LexicalEditor is disposed

Inherited from

Omit.signal

Defined in

types.ts:68