Liking cljdoc? Tell your friends :D

goose.console

Functions to serve the console web interface

Functions to serve the console web interface
raw docstring

app-handlerclj

(app-handler {:keys [broker] :as console-opts} req)

A Ring handler that sets up the necessary middleware and serves Goose Console.

It takes two arguments:

Args

:console-opts : A map of :broker, :route-prefix, & app-name
Example : default-console-opts

:req : Incoming HTTP request

A Ring handler that sets up the necessary middleware and serves Goose Console.

It takes two arguments:

### Args

`:console-opts`   : A map of `:broker`, `:route-prefix`, & `app-name` \
 *Example*        : [[default-console-opts]] 

`:req`            : Incoming HTTP request

- [Console wiki](https://github.com/nilenso/goose/wiki/Console)
sourceraw docstring

default-console-optsclj

Map of sample configs for app-handler.

Keys

:broker : Message broker that transfers message from Producer to Consumer.
Given value must implement goose.broker/Broker protocol.
Message Broker wiki

:route-prefix : Route path that exposes console via app-handler (should not include a trailing "/")
Example : goose.defaults/route-prefix

:app-name : Name to be displayed in console navbar
Example : goose.defaults/app-name

Map of sample configs for app-handler.

### Keys

`:broker`       : Message broker that transfers message from Producer to Consumer.\
 Given value must implement [[goose.broker/Broker]] protocol. \
 [Message Broker wiki](https://github.com/nilenso/goose/wiki/Message-Brokers)

`:route-prefix` : Route path that exposes console via app-handler (should not include a trailing "/") \
  *Example*     : [[goose.defaults/route-prefix]] 

`:app-name`     : Name to be displayed in console navbar \
  *Example*     : [[goose.defaults/app-name]] 
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close