feat(router): add comment to configuration

aurelia · Aug 14, 2019 · 6a34ab3 · 6a34ab3
1 parent 165bfe6
commit 6a34ab3
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/packages/router/src/configuration.ts b/packages/router/src/configuration.ts
@@ -61,7 +61,9 @@ const routerConfiguration = {
 };
 export const RouterConfiguration = {
   /**
-   * Make it possible to specify options to Router activation
+   * Make it possible to specify options to Router activation.
+   * Parameter is either a config object that's passed to Router's activate
+   * or a config function that's called instead of Router's activate.
    */
   customize(config?: IRouterOptions | (() => void)) {
     if (config === undefined) {