Class DeclarativeNodeLoader`Experimental`

Hierarchy

DeclarativeNodeLoader

Implements

IPluginComponent<PagesPlugin>
INodeLoader<DeclarativeNodeLoader.IRawNode, IIOPath>

Index

Constructors

Properties

Methods

canHandle checkConfigNode collectNodes

Constructors

constructor

new DeclarativeNodeLoader(_parent: PluginAccessor<PagesPlugin>, plugin?: PagesPlugin): DeclarativeNodeLoader
Parameters
- _parent: PluginAccessor<PagesPlugin>
- plugin: PagesPlugin = ...
Returns DeclarativeNodeLoader
- Defined in packages/plugin-pages/src/converter/loaders/declarative.ts:28

Properties

`Readonly` plugin

plugin: PagesPlugin = ...

Methods

canHandle

canHandle(rawNode: UnknownNode): boolean
Check if the node can be loaded by this loader.

Returns
true if this loader can be used to load this node.
Parameters
- rawNode: UnknownNode
  
  The node to check.
Returns boolean
Implementation of INodeLoader.canHandle
- Defined in packages/plugin-pages/src/converter/loaders/declarative.ts:36

checkConfigNode

checkConfigNode(rawNode: UnknownNode, context: ICheckConfigContext): asserts rawNode is DeclarativeNodeLoader.IRawNode
Asserts that the given node has a valid config for this loader.
Parameters
- rawNode: UnknownNode
  
  The node to check.
- context: ICheckConfigContext
  
  The check context. Contains an utility to recurse, and the current path.
Returns asserts rawNode is DeclarativeNodeLoader.IRawNode
Implementation of INodeLoader.checkConfigNode
- Defined in packages/plugin-pages/src/converter/loaders/declarative.ts:49

collectNodes

collectNodes(rawNode: DeclarativeNodeLoader.IRawNode, context: IRegisterNodeContext<IIOPath>): NodeGenerator
Expand & yield menus & pages from the given node.

Yields
a list of nodes along with their parents
Parameters
- rawNode: DeclarativeNodeLoader.IRawNode
  
  The node to register.
- context: IRegisterNodeContext<IIOPath>
  
  The context of the current collection. Contains an utility to recurse, a list of parent nodes, and an arbitrary data store generated by parents.
Returns NodeGenerator
Implementation of INodeLoader.collectNodes
- Defined in packages/plugin-pages/src/converter/loaders/declarative.ts:71

Generated using TypeDoc