Skip to content

Commit

Permalink
Latest 0.7.0 snapshot docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hlship committed Apr 2, 2024
1 parent 3b58f46 commit 5b758ac
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 59 deletions.
6 changes: 3 additions & 3 deletions api/0.7/index.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions api/0.7/io.pedestal.http.body-params.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@
<li>:form-params</li>
<li>:transit-params</li>
</ul>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L221">view source</a></div></div><div class="public anchor" id="var-custom-edn-parser"><h3>custom-edn-parser</h3><div class="usage"><code>(custom-edn-parser &amp; options)</code></div><div class="doc"><div class="markdown"><p>Return an edn-parser fn that, given a request, will read the body of that request with <code>edn/read</code>. options are key-val pairs that will be passed as a hash-map to <code>edn/read</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L87">view source</a></div></div><div class="public anchor" id="var-custom-json-parser"><h3>custom-json-parser</h3><div class="usage"><code>(custom-json-parser &amp; options)</code></div><div class="doc"><div class="markdown"><p>Return a json-parser fn that, given a request, will read the body of that request with <code>json/read</code>. options are key-val pairs that will be passed along to <code>json/read</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L129">view source</a></div></div><div class="public anchor" id="var-custom-transit-parser"><h3>custom-transit-parser</h3><div class="usage"><code>(custom-transit-parser &amp; options)</code></div><div class="doc"><div class="markdown"><p>Return a transit-parser fn that, given a request, will read the body of that request with <code>transit/read</code>. options is a sequence to pass to transit/reader along with the body of the request.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L151">view source</a></div></div><div class="public anchor" id="var-default-parser-map"><h3>default-parser-map</h3><div class="usage"><code>(default-parser-map &amp; parser-options)</code></div><div class="doc"><div class="markdown"><p>Return a map of MIME-type to parsers. Included types are edn, json and form-encoding. parser-options are key-val pairs, valid options are:</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L224">view source</a></div></div><div class="public anchor" id="var-custom-edn-parser"><h3>custom-edn-parser</h3><div class="usage"><code>(custom-edn-parser &amp; options)</code></div><div class="doc"><div class="markdown"><p>Return an edn-parser fn that, given a request, will read the body of that request with <code>edn/read</code>. options are key-val pairs that will be passed as a hash-map to <code>edn/read</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L87">view source</a></div></div><div class="public anchor" id="var-custom-json-parser"><h3>custom-json-parser</h3><div class="usage"><code>(custom-json-parser &amp; options)</code></div><div class="doc"><div class="markdown"><p>Return a json-parser fn that, given a request, will read the body of the request with <code>json/parse-stream</code>. options are key-val pairs that will be passed along to <code>json/parse-stream</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L130">view source</a></div></div><div class="public anchor" id="var-custom-transit-parser"><h3>custom-transit-parser</h3><div class="usage"><code>(custom-transit-parser &amp; options)</code></div><div class="doc"><div class="markdown"><p>Return a transit-parser fn that, given a request, will read the body of that request with <code>transit/read</code>. options is a sequence to pass to transit/reader along with the body of the request.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L153">view source</a></div></div><div class="public anchor" id="var-default-parser-map"><h3>default-parser-map</h3><div class="usage"><code>(default-parser-map &amp; parser-options)</code></div><div class="doc"><div class="markdown"><p>Return a map of MIME-type to parsers. Included types are edn, json and form-encoding. parser-options are key-val pairs, valid options are:</p>
<p>:edn-options A hash-map of options to be used when invoking <code>edn/read</code>. :json-options A hash-map of options to be used when invoking <code>json/parse-stream</code>. :transit-options A vector of options to be used when invoking <code>transit/reader</code> - must apply to both json and msgpack</p>
<p>Examples:</p>
<p>(default-parser-map :json-options {:key-fn keyword}) ;; This parser-map would parse the json body ‘{“foo”: “bar”}’ as ;; {:foo “bar”}</p>
<p>(default-parser-map :edn-options {:readers <em>data-readers</em>}) ;; This parser-map will parse edn bodies using any custom edn readers you ;; define (in a data_readers.clj file, for example.)</p>
<p>(default-parser-map :transit-options <a href="{:handlers {&quot;custom/model&quot; custom-model-read-handler}}">{:handlers {“custom/model” custom-model-read-handler}}</a>) ;; This parser-map will parse the transit body using a handler defined by ;; custom-model-read-handler.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L189">view source</a></div></div><div class="public anchor" id="var-edn-parser"><h3>edn-parser</h3><h4 class="deprecated">deprecated in 0.7.0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Take a request and parse its body as edn.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L192">view source</a></div></div><div class="public anchor" id="var-edn-parser"><h3>edn-parser</h3><h4 class="deprecated">deprecated in 0.7.0</h4><div class="usage"><code>(edn-parser &amp; args)</code></div><div class="doc"><div class="markdown"><p>Take a request and parse its body as edn.</p>
<p>Invoke <a href="io.pedestal.http.body-params.html#var-custom-edn-parser">custom-edn-parser</a> instead.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L105">view source</a></div></div><div class="public anchor" id="var-form-parser"><h3>form-parser</h3><div class="usage"><code>(form-parser request)</code></div><div class="doc"><div class="markdown"><p>Take a request and parse its body as a form.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L182">view source</a></div></div><div class="public anchor" id="var-json-parser"><h3>json-parser</h3><h4 class="deprecated">deprecated in 0.7.0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Take a request and parse its body as JSON.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L185">view source</a></div></div><div class="public anchor" id="var-json-parser"><h3>json-parser</h3><h4 class="deprecated">deprecated in 0.7.0</h4><div class="usage"><code>(json-parser &amp; args)</code></div><div class="doc"><div class="markdown"><p>Take a request and parse its body as JSON.</p>
<p>Use <a href="io.pedestal.http.body-params.html#var-custom-json-parser">custom-json-parser</a> instead.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L144">view source</a></div></div><div class="public anchor" id="var-transit-parser"><h3>transit-parser</h3><h4 class="deprecated">deprecated in 0.7.0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Take a request and parse its body as JSON transit.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L145">view source</a></div></div><div class="public anchor" id="var-transit-parser"><h3>transit-parser</h3><h4 class="deprecated">deprecated in 0.7.0</h4><div class="usage"><code>(transit-parser &amp; args)</code></div><div class="doc"><div class="markdown"><p>Take a request and parse its body as JSON transit.</p>
<p>Use <a href="io.pedestal.http.body-params.html#var-custom-transit-parser">custom-transit-parser</a> instead.</p>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L175">view source</a></div></div></div></body></html>
</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/body_params.clj#L177">view source</a></div></div></div></body></html>
5 changes: 3 additions & 2 deletions api/0.7/io.pedestal.http.html

Large diffs are not rendered by default.

Loading

0 comments on commit 5b758ac

Please sign in to comment.