-
Notifications
You must be signed in to change notification settings - Fork 77
/
format.js.html
97 lines (76 loc) · 5.88 KB
/
format.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>format.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-append.html">append</a></li><li><a href="module-appendArray.html">appendArray</a></li><li><a href="module-at.html">at</a></li><li><a href="module-base64decode.html">base64decode</a></li><li><a href="module-base64encode.html">base64encode</a></li><li><a href="module-between.html">between</a></li><li><a href="module-binDecode.html">binDecode</a></li><li><a href="module-binEncode.html">binEncode</a></li><li><a href="module-chars.html">chars</a></li><li><a href="module-collapseWhitespace.html">collapseWhitespace</a></li><li><a href="module-compare.html">compare</a></li><li><a href="module-contains.html">contains</a></li><li><a href="module-containsAll.html">containsAll</a></li><li><a href="module-containsAny.html">containsAny</a></li><li><a href="module-countSubstr.html">countSubstr</a></li><li><a href="module-decDecode.html">decDecode</a></li><li><a href="module-decEncode.html">decEncode</a></li><li><a href="module-endsWith.html">endsWith</a></li><li><a href="module-ensureLeft.html">ensureLeft</a></li><li><a href="module-ensureRight.html">ensureRight</a></li><li><a href="module-equal.html">equal</a></li><li><a href="module-first.html">first</a></li><li><a href="module-format.html">format</a></li><li><a href="module-hexDecode.html">hexDecode</a></li><li><a href="module-hexEncode.html">hexEncode</a></li><li><a href="module-htmlDecode.html">htmlDecode</a></li><li><a href="module-htmlEncode.html">htmlEncode</a></li><li><a href="module-inequal.html">inequal</a></li><li><a href="module-insert.html">insert</a></li><li><a href="module-isLowerCase.html">isLowerCase</a></li><li><a href="module-isString.html">isString</a></li><li><a href="module-isUpperCase.html">isUpperCase</a></li><li><a href="module-last.html">last</a></li><li><a href="module-lastIndefOf.html">lastIndefOf</a></li><li><a href="module-leftPad.html">leftPad</a></li><li><a href="module-leftTrim.html">leftTrim</a></li><li><a href="module-prepend.html">prepend</a></li><li><a href="module-prependArray.html">prependArray</a></li><li><a href="module-removeEmptyStrings.html">removeEmptyStrings</a></li><li><a href="module-removeLeft.html">removeLeft</a></li><li><a href="module-removeNonWords.html">removeNonWords</a></li><li><a href="module-removeSpaces.html">removeSpaces</a></li><li><a href="module-repeat.html">repeat</a></li><li><a href="module-replace.html">replace</a></li><li><a href="module-reverse.html">reverse</a></li><li><a href="module-rightPad.html">rightPad</a></li><li><a href="module-rightTrim.html">rightTrim</a></li><li><a href="module-safeTruncate.html">safeTruncate</a></li><li><a href="module-shuffle.html">shuffle</a></li><li><a href="module-slugify.html">slugify</a></li><li><a href="module-split.html">split</a></li><li><a href="module-startsWith.html">startsWith</a></li><li><a href="module-substr.html">substr</a></li><li><a href="module-surround.html">surround</a></li><li><a href="module-toCamelCase.html">toCamelCase</a></li><li><a href="module-toDecamelize.html">toDecamelize</a></li><li><a href="module-toKebabCase.html">toKebabCase</a></li><li><a href="module-toLowerCase.html">toLowerCase</a></li><li><a href="module-toSnakeCase.html">toSnakeCase</a></li><li><a href="module-toStudlyCaps.html">toStudlyCaps</a></li><li><a href="module-toUpperCase.html">toUpperCase</a></li><li><a href="module-transliterate.html">transliterate</a></li><li><a href="module-trim.html">trim</a></li><li><a href="module-truncate.html">truncate</a></li><li><a href="module-urlDecode.html">urlDecode</a></li><li><a href="module-urlEncode.html">urlEncode</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">format.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import replace from './replace'
/**
* @module format
* @description
* Formats a string using parameters.
* ## Install
* Install all functions of strman
* ```sh
* yarn add strman
* ```
* or just the format function
* ```sh
* yarn add strman.format
* ```
* ## Usage
* ```javascript
* import { format } from 'strman'
* // OR
* import format from 'strman.format'
* ```
* @param {String} value - Value that will be formatted.
* @param {String[]} params - Array with the parameters described in the string.
* @example
* const select = `SELECT * FROM CONTACTS WHERE NAME LIKE '%{0}%' AND EMAIL LIKE '%{1}%'`
* format(select, 'DANIEL', 'GMAIL')
* // => `SELECT * FROM CONTACTS WHERE NAME LIKE '%DANIEL%' AND EMAIL LIKE '%GMAIL%'`
* @returns {String} Formatted string.
*/
export default (value, params = []) =>
replace(value, '{(\\w+)}',
(match, index) => {
if (typeof params[index] !== 'undefined') {
return params[index]
}
return match
},
)
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Mar 26 2017 19:28:03 GMT-0300 (BRT) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>