lodash-contrib
Version:
The brass buckles on lodash's utility belt
185 lines (144 loc) • 7.12 kB
HTML
<html>
<head>
<title>_.util.strings.js.md</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page_wrapper">
<div id="jump_page">
<a class="source" href="_.array.builders.js.html">
_.array.builders.js.md
</a>
<a class="source" href="_.array.selectors.js.html">
_.array.selectors.js.md
</a>
<a class="source" href="_.collections.walk.js.html">
_.collections.walk.js.md
</a>
<a class="source" href="_.function.arity.js.html">
_.function.arity.js.md
</a>
<a class="source" href="_.function.combinators.js.html">
_.function.combinators.js.md
</a>
<a class="source" href="_.function.iterators.js.html">
_.function.iterators.js.md
</a>
<a class="source" href="_.function.predicates.js.html">
_.function.predicates.js.md
</a>
<a class="source" href="_.object.builders.js.html">
_.object.builders.js.md
</a>
<a class="source" href="_.object.selectors.js.html">
_.object.selectors.js.md
</a>
<a class="source" href="_.util.existential.js.html">
_.util.existential.js.md
</a>
<a class="source" href="_.util.operators.js.html">
_.util.operators.js.md
</a>
<a class="source" href="_.util.strings.js.html">
_.util.strings.js.md
</a>
<a class="source" href="_.util.trampolines.js.html">
_.util.trampolines.js.md
</a>
<a class="source" href="index.html">
index.md
</a>
</div>
</div>
</li>
</ul>
<ul class="sections">
<li id="title">
<div class="annotation">
<h1>_.util.strings.js.md</h1>
</div>
</li>
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
<h3 id="util-strings">util.strings</h3>
<blockquote>
<p>Functions for working with strings.</p>
</blockquote>
<hr>
<h4 id="camelcase">camelCase</h4>
<p><strong>Signature:</strong> <code>_.camelCase(string:String)</code></p>
<p>Converts a dash-separated string to camel case. Opposite of <a href="#todash">toDash</a>.</p>
<pre><code class="lang-javascript">_.camelCase(<span class="hljs-string">"ancient-greece"</span>);
<span class="hljs-comment">// => "ancientGreece"</span>
</code></pre>
<hr>
<h4 id="explode">explode</h4>
<p><strong>Signature:</strong> <code>_.explode(s:String)</code></p>
<p>Explodes a string into an array of characters. Opposite of <a href="#implode">implode</a>.</p>
<pre><code class="lang-javascript">_.explode(<span class="hljs-string">"Plato"</span>);
<span class="hljs-comment">// => ["P", "l", "a", "t", "o"]</span>
</code></pre>
<hr>
<h4 id="fromquery">fromQuery</h4>
<p><strong>Signature:</strong> <code>_.fromQuery(str:String)</code></p>
<p>Takes a URL query string and converts it into an equivalent JavaScript object.
Opposite of <a href="#toquery">toQuery</a></p>
<pre><code class="lang-javascript">_.fromQuery(<span class="hljs-string">"forms%5Bperfect%5D=circle&forms%5Bimperfect%5D=square"</span>);
<span class="hljs-comment">// => { forms: { perfect: "circle", imperfect: "square" } }</span>
</code></pre>
<hr>
<h4 id="implode">implode</h4>
<p><strong>Signature:</strong> <code>_.implode(a:Array)</code></p>
<p>Implodes an array of strings into a single string. Opposite of <a href="#explode">explode</a>.</p>
<pre><code class="lang-javascript">_.implode([<span class="hljs-string">"H"</span>, <span class="hljs-string">"o"</span>, <span class="hljs-string">"m"</span>, <span class="hljs-string">"e"</span>, <span class="hljs-string">"r"</span>]);
<span class="hljs-comment">// => "Homer"</span>
</code></pre>
<hr>
<h4 id="slugify">slugify</h4>
<p><strong>Signature:</strong> <code>_.slugify(str:String)</code></p>
<p>Slugifies a string, converting spaces and dots to dashes and inserting dashes between words.</p>
<pre><code class="lang-javascript">_.slugify(<span class="hljs-string">"ExampleString.that-covers-it.all"</span>);
<span class="hljs-comment">// => "example-string-that-covers-it-all"</span>
</code></pre>
<hr>
<h4 id="strcontains">strContains</h4>
<p><strong>Signature:</strong> <code>_.strContains(str:String, search:String)</code></p>
<p>Reports whether a string contains a search string.</p>
<pre><code class="lang-javascript">_.strContains(<span class="hljs-string">"Acropolis"</span>, <span class="hljs-string">"polis"</span>);
<span class="hljs-comment">// => true</span>
</code></pre>
<hr>
<h4 id="todash">toDash</h4>
<p><strong>Signature:</strong> <code>_.toDash(string:String)</code></p>
<p>Converts a camel case string to a dashed string. Opposite of <a href="#camelcase">camelCase</a>.</p>
<pre><code class="lang-javascript">_.toDash(<span class="hljs-string">"thisIsSparta"</span>);
<span class="hljs-comment">// => "this-is-sparta"</span>
</code></pre>
<hr>
<h4 id="toquery">toQuery</h4>
<p><strong>Signature:</strong> <code>_.toQuery(obj:Object)</code></p>
<p>Takes an object and converts it into an equivalent URL query string. Opposite
of <a href="#fromquery">fromQuery</a>.</p>
<pre><code class="lang-javascript">_.toQuery({ forms: { perfect: <span class="hljs-string">"circle"</span>, imperfect: <span class="hljs-string">"square"</span> } });
<span class="hljs-comment">// => "forms%5Bperfect%5D=circle&forms%5Bimperfect%5D=square"</span>
</code></pre>
<hr>
</div>
</li>
</ul>
</div>
</body>
</html>