diff --git a/doc/advanced/configuring_routers.md b/doc/advanced/configuring_routers.md index 3bd4a982..223d9959 100644 --- a/doc/advanced/configuring_routers.md +++ b/doc/advanced/configuring_routers.md @@ -11,9 +11,9 @@ Routers can be configured via options. The following options are available for t | `:syntax` | Path-parameter syntax as keyword or set of keywords (default #{:bracket :colon}) | `:expand` | Function of `arg opts => data` to expand route arg to route data (default `reitit.core/expand`) | `:coerce` | Function of `route opts => route` to coerce resolved route, can throw or return `nil` -| `:meta-merge` | Function which follows the signature of `meta-merge.core/meta-merge`, useful for when you want to have more control over the meta merging | `:compile` | Function of `route opts => result` to compile a route handler | `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects | `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes | `:exception` | Function of `Exception => Exception ` to handle creation time exceptions (default `reitit.exception/exception`) +| `:meta-merge` | Function of `left right => merged` to merge route-data (default `meta-merge.core/meta-merge`) | `:router` | Function of `routes opts => router` to override the actual router implementation diff --git a/modules/reitit-core/src/reitit/core.cljc b/modules/reitit-core/src/reitit/core.cljc index 0b32fd73..cd3b092b 100644 --- a/modules/reitit-core/src/reitit/core.cljc +++ b/modules/reitit-core/src/reitit/core.cljc @@ -314,20 +314,21 @@ Selects implementation based on route details. The following options are available: - | key | description - | -------------|------------- - | `:path` | Base-path for routes - | `:routes` | Initial resolved routes (default `[]`) - | `:data` | Initial route data (default `{}`) - | `:spec` | clojure.spec definition for a route data, see `reitit.spec` on how to use this - | `:syntax` | Path-parameter syntax as keyword or set of keywords (default #{:bracket :colon}) - | `:expand` | Function of `arg opts => data` to expand route arg to route data (default `reitit.core/expand`) - | `:coerce` | Function of `route opts => route` to coerce resolved route, can throw or return `nil` - | `:compile` | Function of `route opts => result` to compile a route handler - | `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects - | `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes - | `:exception` | Function of `Exception => Exception ` to handle creation time exceptions (default `reitit.exception/exception`) - | `:router` | Function of `routes opts => router` to override the actual router implementation" + | key | description + | --------------|------------- + | `:path` | Base-path for routes + | `:routes` | Initial resolved routes (default `[]`) + | `:data` | Initial route data (default `{}`) + | `:spec` | clojure.spec definition for a route data, see `reitit.spec` on how to use this + | `:syntax` | Path-parameter syntax as keyword or set of keywords (default #{:bracket :colon}) + | `:expand` | Function of `arg opts => data` to expand route arg to route data (default `reitit.core/expand`) + | `:coerce` | Function of `route opts => route` to coerce resolved route, can throw or return `nil` + | `:compile` | Function of `route opts => result` to compile a route handler + | `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects + | `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes + | `:exception` | Function of `Exception => Exception ` to handle creation time exceptions (default `reitit.exception/exception`) + | `:meta-merge` | Function of `left right => merged` to merge route-data (default `meta-merge.core/meta-merge`) + | `:router` | Function of `routes opts => router` to override the actual router implementation" ([raw-routes] (router raw-routes {})) ([raw-routes opts]