reitit.core — metosin/reitit 0.5.1

Expand clj/s protocol

expand clj/s

(expand this opts)

linear-router clj/s

(linear-router compiled-routes)

(linear-router compiled-routes opts)

Creates a linear-router from resolved routes and optional expanded options. See router for available options, plus the following:

key	description
:reitit.trie/trie-compiler	Optional trie-compiler.
:reitit.trie/parameters	Optional function to create empty map(-like) path parameters value from sequence of keys.

lookup-router clj/s

(lookup-router compiled-routes)

(lookup-router compiled-routes opts)

Creates a lookup-router from resolved routes and optional expanded options. See router for available options.

Match clj/s

match->path clj/s

(match->path match)

(match->path match query-params)

match-by-name! clj/s

(match-by-name! this name)

(match-by-name! this name path-params)

mixed-router clj/s

(mixed-router compiled-routes)

(mixed-router compiled-routes opts)

Creates two routers: lookup-router or single-static-path-router for static routes and [[segment-router]] for wildcard routes. All routes should be non-conflicting. Takes resolved routes and optional expanded options. See router for options.

partial-match? clj/s

(partial-match? x)

PartialMatch clj/s

quarantine-router clj/s

(quarantine-router compiled-routes)

(quarantine-router compiled-routes opts)

Creates two routers: mixed-router for non-conflicting routes and linear-router for conflicting routes. Takes resolved routes and optional expanded options. See router for options.

Router clj/s protocol

compiled-routes clj/s

(compiled-routes this)

match-by-name clj/s

(match-by-name this name)

(match-by-name this name path-params)

match-by-path clj/s

(match-by-path this path)

options clj/s

(options this)

route-names clj/s

(route-names this)

router-name clj/s

(router-name this)

routes clj/s

(routes this)

router clj/s

(router raw-routes)

(router raw-routes opts)

Create a Router from raw route data and optionally an options map. 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

router? clj/s

(router? x)

single-static-path-router clj/s

(single-static-path-router compiled-routes)

(single-static-path-router compiled-routes opts)

Creates a fast router of 1 static route(s) and optional expanded options. See router for available options.

trie-router clj/s

(trie-router compiled-routes)

(trie-router compiled-routes opts)

Creates a special prefix-tree router from resolved routes and optional expanded options. See router for available options, plus the following:

key	description
:reitit.trie/trie-compiler	Optional trie-compiler.
:reitit.trie/parameters	Optional function to create empty map(-like) path parameters value from sequence of keys.