106 lines
4.1 KiB
HTML
106 lines
4.1 KiB
HTML
<html>
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title> buildPathname(object) - Mithril.js</title>
|
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" />
|
|
<link href="style.css" rel="stylesheet" />
|
|
<link rel="icon" type="image/png" sizes="32x32" href="favicon.png" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<section>
|
|
<a class="hamburger" href="javascript:;">≡</a>
|
|
<h1><img src="logo.svg"> Mithril <small>2.0.0-rc.5</small></h1>
|
|
<nav>
|
|
<a href="index.html">Guide</a>
|
|
<a href="api.html">API</a>
|
|
<a href="https://gitter.im/MithrilJS/mithril.js">Chat</a>
|
|
<a href="https://github.com/MithrilJS/mithril.js">GitHub</a>
|
|
</nav>
|
|
</section>
|
|
</header>
|
|
<main>
|
|
<section>
|
|
<h1 id="buildpathnameobject"><a href="#buildpathnameobject">buildPathname(object)</a></h1>
|
|
<ul>
|
|
<li>Core<ul>
|
|
<li><a href="hyperscript.html">m</a></li>
|
|
<li><a href="render.html">m.render</a></li>
|
|
<li><a href="mount.html">m.mount</a></li>
|
|
<li><a href="route.html">m.route</a></li>
|
|
<li><a href="request.html">m.request</a></li>
|
|
<li><a href="jsonp.html">m.jsonp</a></li>
|
|
<li><a href="parseQueryString.html">m.parseQueryString</a></li>
|
|
<li><a href="buildQueryString.html">m.buildQueryString</a></li>
|
|
<li><a href="trust.html">m.trust</a></li>
|
|
<li><a href="fragment.html">m.fragment</a></li>
|
|
<li><a href="redraw.html">m.redraw</a></li>
|
|
<li><a href="version.html">m.version</a></li>
|
|
<li><a href="promise.html">Promise</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>Optional<ul>
|
|
<li><a href="stream.html">Stream</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>Tooling<ul>
|
|
<li><a href="https://github.com/MithrilJS/mithril.js/blob/master/ospec">Ospec</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h3 id="description"><a href="#description">Description</a></h3>
|
|
<p>Turns a <a href="paths.html">path template</a> and a parameters object into a string of form <code>/path/user?a=1&b=2</code></p>
|
|
<pre><code class="language-javascript">var querystring = m.buildPathname("/path/:id", {id: "user", a: "1", b: "2"})
|
|
// "/path/user?a=1&b=2"</code></pre>
|
|
<hr>
|
|
<h3 id="signature"><a href="#signature">Signature</a></h3>
|
|
<p><code>querystring = m.buildPathname(object)</code></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Type</th>
|
|
<th>Required</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><code>object</code></td>
|
|
<td><code>Object</code></td>
|
|
<td>Yes</td>
|
|
<td>A key-value map to be converted into a string</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>returns</strong></td>
|
|
<td><code>String</code></td>
|
|
<td></td>
|
|
<td>A string representing the input object</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<p><a href="signatures.html">How to read signatures</a></p>
|
|
<hr>
|
|
<h3 id="how-it-works"><a href="#how-it-works">How it works</a></h3>
|
|
<p>The <code>m.buildPathname</code> creates a <a href="paths.html">path name</a> from a path template and a parameters object. It's useful for building URLs, and it's what <a href="route.html"><code>m.route</code></a>, <a href="request.html"><code>m.request</code></a>, and <a href="jsonp.html"><code>m.jsonp</code></a> all use internally to interpolate paths. It uses <a href="buildQueryString.html"><code>m.buildQueryString</code></a> to generate the query parameters to append to the path name.</p>
|
|
<pre><code class="language-javascript">var querystring = m.buildPathname("/path/:id", {id: "user", a: 1, b: 2})
|
|
|
|
// querystring is "/path/user?a=1&b=2"</code></pre>
|
|
|
|
<hr />
|
|
<small>License: MIT. © Leo Horie.</small>
|
|
</section>
|
|
</main>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/prism.min.js" defer></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-jsx.min.js" defer></script>
|
|
<script src="https://unpkg.com/mithril@2.0.0-rc.5/mithril.js" async></script>
|
|
<script>
|
|
document.querySelector(".hamburger").onclick = function() {
|
|
document.body.className = document.body.className === "navigating" ? "" : "navigating"
|
|
document.querySelector("h1 + ul").onclick = function() {
|
|
document.body.className = ''
|
|
}
|
|
}
|
|
</script>
|
|
</body>
|
|
</html>
|