Interface: PlanInitState
An object that the register method can use to detect unmount and access the configuration for plan dependencies
Properties
getDependency()
getDependency: <
Dependency>(dep) =>Omit<LexicalPlanDependency<Dependency>,"output">
Get the configuration of a dependency by plan (must be a direct dependency of this plan)
Type Parameters
• Dependency extends AnyLexicalPlan
Parameters
• dep: Dependency
Returns
Omit<LexicalPlanDependency<Dependency>, "output">
Defined in
getDirectDependentNames()
getDirectDependentNames: () =>
ReadonlySet<string>
Get the names of any direct dependents of this Plan, typically only used for error messages.
Returns
ReadonlySet<string>
Defined in
getPeer()
getPeer: <
Dependency>(name) =>undefined|Omit<LexicalPlanDependency<Dependency>,"output">
Get the result of a peerDependency by name, if it exists (must be a peerDependency of this plan)
Type Parameters
• Dependency extends AnyLexicalPlan = never
Parameters
• name: Dependency["name"]
Returns
undefined | Omit<LexicalPlanDependency<Dependency>, "output">
Defined in
getPeerNameSet()
getPeerNameSet: () =>
ReadonlySet<string>
Get the names of all peer dependencies of this Plan, even if they do not exist in the builder, typically only used for devtools.
Returns
ReadonlySet<string>
Defined in
signal
signal:
AbortSignal
An AbortSignal that is aborted when the LexicalEditor is disposed