Class Routes

Implements

IExtender

Index

Constructors

Methods

add extend helper

Constructors

constructor

new Routes(): Routes
Returns Routes

Methods

add

add(
    name: string,
    path: `/${string}`,
    component: NewComponent<any> | AsyncNewComponent<any>,
    resolverClass?: typeof DefaultResolver,
): Routes
Add a mithril route to the application.
Parameters
- name: string
  The name of the route.
- path: `/${string}`
  The path of the route.
- component: NewComponent<any> | AsyncNewComponent<any>
  must extend Page component.
- OptionalresolverClass: typeof DefaultResolver
  An optional custom route resolver class.
Returns Routes
- Defined in flarum/framework/core/js/src/common/extenders/Routes.ts:20

extend

extend(app: Application, extension: IExtensionModule): void
Parameters
- app: Application
- extension: IExtensionModule
Returns void
Implementation of IExtender.extend
- Defined in flarum/framework/core/js/src/common/extenders/Routes.ts:38

helper

helper(name: string, callback: HelperRoute): Routes
Parameters
- name: string
- callback: HelperRoute
Returns Routes
- Defined in flarum/framework/core/js/src/common/extenders/Routes.ts:32