Class RouterPlugin

Plugin for working with routes and URL path formats.

Hierarchy

RouterPlugin

Implements

PluginComponent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RouterPlugin(pod: Pod): RouterPlugin

- Defined in packages/amagaki/src/plugins/router.ts:11
Parameters
- pod: Pod
Returns RouterPlugin

Properties

formatters

formatters: Record<string, Function>

pod

pod: Pod

Methods

addPathFormatFunction

addPathFormatFunction(name: string, func: Function): void

- Defined in packages/amagaki/src/plugins/router.ts:29
Adds a path formatter function to make it available from a document or collection's $path setting.
For example, if a document's $path is set to:
```
$path: /blog/articles/${slugify(doc.fields.title)}/
```
You could then add a path formatter with name slugify to create a URL for the document, based on its title field.
Parameters
- name: string
- func: Function
Returns void

updatePathFormatContextHook

updatePathFormatContextHook(context: Record<string, any>): void

Implementation of PluginComponent.updatePathFormatContextHook
- Defined in packages/amagaki/src/plugins/router.ts:38
Hook for extending the URL path interpolation context.

Parameters
- context: Record<string, any>
Returns void

Generated using TypeDoc