Class TemplateNodeLoader`Experimental`

Hierarchy

TemplateNodeLoader

Implements

IPluginComponent<PagesPlugin>
INodeLoader<TemplateNodeLoader.IRawNode, ITemplateMatch[]>

Index

Constructors

Properties

Methods

canHandle checkConfigNode collectNodes

Constructors

constructor

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

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/template.ts:48

checkConfigNode

checkConfigNode(rawNode: UnknownNode, context: ICheckConfigContext): asserts rawNode is TemplateNodeLoader.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 TemplateNodeLoader.IRawNode
Implementation of INodeLoader.checkConfigNode
- Defined in packages/plugin-pages/src/converter/loaders/template.ts:58

collectNodes

collectNodes(rawNode: TemplateNodeLoader.IRawNode, context: IRegisterNodeContext<ITemplateMatch[]>): NodeGenerator
Expand & yield menus & pages from the given node.

Yields
a list of nodes along with their parents
Parameters
- rawNode: TemplateNodeLoader.IRawNode
  
  The node to register.
- context: IRegisterNodeContext<ITemplateMatch[]>
  
  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/template.ts:82

Generated using TypeDoc