Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 19 lines (19 sloc) 10.35 kb
1090fea @ibdknox update history, move to beta1, document custom-handler*
authored
1 <!DOCTYPE html>
2 <html><head><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>Noir 1.3.0-beta1 API documentation</title></head><body><div id="header"><h1><a href="index.html">Noir 1.3.0-beta1 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3>Namespaces</h3><ul><li><a href="noir.cookies.html"><span>noir.cookies</span></a></li><li><a href="noir.core.html"><span>noir.core</span></a></li><li><a href="noir.options.html"><span>noir.options</span></a></li><li><a href="noir.request.html"><span>noir.request</span></a></li><li><a href="noir.response.html"><span>noir.response</span></a></li><li><a href="noir.server.html"><span>noir.server</span></a></li><li><a href="noir.server.handler.html"><span>noir.server.handler</span></a></li><li><a href="noir.session.html"><span>noir.session</span></a></li><li><a href="noir.statuses.html"><span>noir.statuses</span></a></li><li><a href="noir.util.crypt.html"><span>noir.util.crypt</span></a></li><li><a href="noir.util.gae.html"><span>noir.util.gae</span></a></li><li><a href="noir.util.test.html"><span>noir.util.test</span></a></li><li><a href="noir.validation.html"><span>noir.validation</span></a></li></ul></div><div class="namespace-index" id="content"><h2>Noir 1.3.0-beta1 API documentation</h2><div class="doc">Noir - a clojure web framework</div><div class="namespace"><h3><a href="noir.cookies.html"><span>noir.cookies</span></a></h3><pre class="doc">Stateful access to cookie values
3 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.cookies.html#var-get"><span>get</span></a></li><li><a href="noir.cookies.html#var-get-signed"><span>get-signed</span></a></li><li><a href="noir.cookies.html#var-put%21"><span>put!</span></a></li><li><a href="noir.cookies.html#var-put-signed%21"><span>put-signed!</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.core.html"><span>noir.core</span></a></h3><pre class="doc">Functions to work with partials and pages.
4 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.core.html#var-compojure-route"><span>compojure-route</span></a></li><li><a href="noir.core.html#var-custom-handler"><span>custom-handler</span></a></li><li><a href="noir.core.html#var-custom-handler*"><span>custom-handler*</span></a></li><li><a href="noir.core.html#var-defpage"><span>defpage</span></a></li><li><a href="noir.core.html#var-defpartial"><span>defpartial</span></a></li><li><a href="noir.core.html#var-post-route"><span>post-route</span></a></li><li><a href="noir.core.html#var-pre-route"><span>pre-route</span></a></li><li><a href="noir.core.html#var-render"><span>render</span></a></li><li><a href="noir.core.html#var-url-for"><span>url-for</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.options.html"><span>noir.options</span></a></h3><pre class="doc">Allows access to Noir's server options
5 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.options.html#var-dev-mode%3F"><span>dev-mode?</span></a></li><li><a href="noir.options.html#var-get"><span>get</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.request.html"><span>noir.request</span></a></h3><pre class="doc">Functions for accessing the original request object from within noir handlers
6 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.request.html#var-ring-request"><span>ring-request</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.response.html"><span>noir.response</span></a></h3><pre class="doc">Simple response helpers to change the content type, redirect, or return a canned response
7 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.response.html#var-content-type"><span>content-type</span></a></li><li><a href="noir.response.html#var-empty"><span>empty</span></a></li><li><a href="noir.response.html#var-json"><span>json</span></a></li><li><a href="noir.response.html#var-jsonp"><span>jsonp</span></a></li><li><a href="noir.response.html#var-redirect"><span>redirect</span></a></li><li><a href="noir.response.html#var-set-headers"><span>set-headers</span></a></li><li><a href="noir.response.html#var-status"><span>status</span></a></li><li><a href="noir.response.html#var-xml"><span>xml</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.server.html"><span>noir.server</span></a></h3><pre class="doc">A collection of functions to handle Noir's server and add middleware to the stack.
8 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.server.html#var-add-middleware"><span>add-middleware</span></a></li><li><a href="noir.server.html#var-gen-handler"><span>gen-handler</span></a></li><li><a href="noir.server.html#var-load-views"><span>load-views</span></a></li><li><a href="noir.server.html#var-load-views-ns"><span>load-views-ns</span></a></li><li><a href="noir.server.html#var-restart"><span>restart</span></a></li><li><a href="noir.server.html#var-start"><span>start</span></a></li><li><a href="noir.server.html#var-stop"><span>stop</span></a></li><li><a href="noir.server.html#var-wrap-route"><span>wrap-route</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.server.handler.html"><span>noir.server.handler</span></a></h3><pre class="doc">Handler generation functions used by noir.server and other ring handler libraries.
9 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.server.handler.html#var-add-custom-middleware"><span>add-custom-middleware</span></a></li><li><a href="noir.server.handler.html#var-base-handler"><span>base-handler</span></a></li><li><a href="noir.server.handler.html#var-wrap-noir-middleware"><span>wrap-noir-middleware</span></a></li><li><a href="noir.server.handler.html#var-wrap-spec-routes"><span>wrap-spec-routes</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.session.html"><span>noir.session</span></a></h3><pre class="doc">Stateful session handling functions. Uses a memory-store by
10 default, but can use a custom store by supplying a :session-store
11 option to server/start.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.session.html#var-clear%21"><span>clear!</span></a></li><li><a href="noir.session.html#var-flash-get"><span>flash-get</span></a></li><li><a href="noir.session.html#var-flash-put%21"><span>flash-put!</span></a></li><li><a href="noir.session.html#var-get"><span>get</span></a></li><li><a href="noir.session.html#var-put%21"><span>put!</span></a></li><li><a href="noir.session.html#var-remove%21"><span>remove!</span></a></li><li><a href="noir.session.html#var-swap%21"><span>swap!</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.statuses.html"><span>noir.statuses</span></a></h3><pre class="doc">If no pages are defined that match a request, a status page is used based on the
12 the HTTP status code of the response. This contains the function necessary to get
13 or set these status pages.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.statuses.html#var-get-page"><span>get-page</span></a></li><li><a href="noir.statuses.html#var-set-page%21"><span>set-page!</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.util.crypt.html"><span>noir.util.crypt</span></a></h3><pre class="doc">Simple functions for hashing strings and comparing them. Typically used for storing passwords.
14 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.util.crypt.html#var-compare"><span>compare</span></a></li><li><a href="noir.util.crypt.html#var-encrypt"><span>encrypt</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.util.gae.html"><span>noir.util.gae</span></a></h3><pre class="doc">Functions to help run noir on Google App Engine.
15 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.util.gae.html#var-gae-handler"><span>gae-handler</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.util.test.html"><span>noir.util.test</span></a></h3><pre class="doc">A set of utilities for testing a Noir project
16 </pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.util.test.html#var-has-body"><span>has-body</span></a></li><li><a href="noir.util.test.html#var-has-content-type"><span>has-content-type</span></a></li><li><a href="noir.util.test.html#var-has-status"><span>has-status</span></a></li><li><a href="noir.util.test.html#var-send-request"><span>send-request</span></a></li><li><a href="noir.util.test.html#var-send-request-map"><span>send-request-map</span></a></li><li><a href="noir.util.test.html#var-with-noir"><span>with-noir</span></a></li></ul></div></div><div class="namespace"><h3><a href="noir.validation.html"><span>noir.validation</span></a></h3><pre class="doc">Functions for validating input and setting string errors on fields.
17 All fields are simply keys, meaning this can be a general error storage and
18 retrieval mechanism for the lifetime of a single request. Errors are not
19 persisted and are cleaned out at the end of the request.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="noir.validation.html#var-errors%3F"><span>errors?</span></a></li><li><a href="noir.validation.html#var-get-errors"><span>get-errors</span></a></li><li><a href="noir.validation.html#var-has-value%3F"><span>has-value?</span></a></li><li><a href="noir.validation.html#var-has-values%3F"><span>has-values?</span></a></li><li><a href="noir.validation.html#var-is-email%3F"><span>is-email?</span></a></li><li><a href="noir.validation.html#var-max-length%3F"><span>max-length?</span></a></li><li><a href="noir.validation.html#var-min-length%3F"><span>min-length?</span></a></li><li><a href="noir.validation.html#var-not-nil%3F"><span>not-nil?</span></a></li><li><a href="noir.validation.html#var-on-error"><span>on-error</span></a></li><li><a href="noir.validation.html#var-rule"><span>rule</span></a></li><li><a href="noir.validation.html#var-set-error"><span>set-error</span></a></li></ul></div></div></div></body></html>
Something went wrong with that request. Please try again.