UNPKG

aurelia-router-metadata

Version:

Adds decorator configuration with conventions and eager loading capabilities to aurelia-router

27 lines (26 loc) 1.2 kB
import { IRouterResourceTarget } from "./interfaces"; import { RouterResource } from "./router-resource"; /** * Helpers for working with router metadata on ViewModels */ export interface IRouterMetadataType { /** * Gets router metadata specified on a target, only searching the own instance. * @param target The target to lookup the metadata on. */ getOwn(target: IRouterResourceTarget): RouterResource; /** * Defines router metadata on a target. * @param metadataKey The key for the metadata to define. * @param target The target to set the metadata on. */ define(metadataValue: RouterResource, target: IRouterResourceTarget): void; /** * Gets router metadata specified on a target, or creates an instance of the specified metadata if not found. * @param metadataKey The key for the metadata to lookup or create. * @param target The target to lookup or create the metadata on. * @param moduleId The moduleId associated with the target to lookup or create the metadata on. */ getOrCreateOwn(target: IRouterResourceTarget, moduleId?: string): RouterResource; } export declare const routerMetadata: IRouterMetadataType;