1 | <!doctype html>
|
2 | <html>
|
3 |
|
4 | <head>
|
5 | <meta name="generator" content="JSDoc 3.6.2">
|
6 | <meta charset="utf-8">
|
7 | <title>keyu 2.0.0 » Home</title>
|
8 | <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
|
9 | <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
|
10 | <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
|
11 | <link href="css/baseline.css" rel="stylesheet">
|
12 | </head>
|
13 |
|
14 | <body onload="prettyPrint()">
|
15 | <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
|
16 | <div id="jsdoc-navbar-container">
|
17 | <div id="jsdoc-navbar-content">
|
18 | <a href="index.html" class="jsdoc-navbar-package-name">keyu 2.<wbr>0.<wbr>0</a>
|
19 | </div>
|
20 | </div>
|
21 | </nav>
|
22 | <div id="jsdoc-body-container">
|
23 | <div id="jsdoc-content">
|
24 | <div id="jsdoc-content-container">
|
25 | <div id="jsdoc-banner" role="banner">
|
26 | </div>
|
27 | <div id="jsdoc-main" role="main">
|
28 | <header class="page-header">
|
29 | <h1>
|
30 | keyu 2.0.0
|
31 | </h1>
|
32 | </header>
|
33 | <article>
|
34 | <p><img src="logo.png" alt="logo"></p>
|
35 | <p><a href="https://travis-ci.org/nerac/keyu"><img src="https://travis-ci.org/nerac/keyu.svg?branch=master" alt="Build Status"></a>
|
36 | <a href="https://coveralls.io/github/nerac/keyu?branch=master"><img src="https://coveralls.io/repos/github/nerac/keyu/badge.svg?branch=master" alt="Coverage Status"></a>
|
37 | <a href="https://packagephobia.now.sh/result?p=keyu"><img src="https://packagephobia.now.sh/badge?p=keyu" alt="install size"></a>
|
38 | <a href="https://snyk.io/test/npm/keyu"><img src="https://snyk.io/test/npm/keyu/badge.svg" alt="Known Vulnerabilities"></a></p>
|
39 | <p><strong>Keyu</strong> (key utilities) provides <strong>flexible</strong> utilities to help you build <strong>solid</strong> projects <u>without repeating yourself</u>.
|
40 | This library pretends to <strong>fix</strong> those <strong>anoying things</strong> that you find every day <strong>when you write JavaScript</strong></p>
|
41 | <p>The library helps you:</p>
|
42 | <ul>
|
43 | <li>Write functional programming code in javascript</li>
|
44 | <li>Combine sync and async functions easly</li>
|
45 | <li>Do safe conversions</li>
|
46 | <li>Check javascript types correctly</li>
|
47 | <li>Work with any kind of collection</li>
|
48 | <li>Apply complex concurrency patterns (<a href="https://www.youtube.com/watch?v=f6kdp27TYZs">Rob Pike</a>).</li>
|
49 | </ul>
|
50 | <p>Documentation: https://nerac.github.io/keyu/</p>
|
51 | <p>Repository: https://github.com/nerac/keyu</p>
|
52 | <p>License: <a href="https://github.com/nerac/keyu/blob/master/LICENSE">MIT</a></p>
|
53 | <h2>Contribute</h2>
|
54 | <p>If you find yourself repeating over and over the same function maybe it should be here.</p>
|
55 | <p>This repository is completely open to any kind of contribution that will simplify Javascript
|
56 | developers time.</p>
|
57 | </article>
|
58 | <div class="symbol-index">
|
59 | <section>
|
60 | <div class="symbol-index-content">
|
61 | <h2 id="collections">collections</h2>
|
62 | <div class="symbol-index-section">
|
63 | <div class="symbol-index-column">
|
64 | <dl class="symbol-index-list">
|
65 | <dt class="symbol-index-name">
|
66 | <a href="module-collections.html" class="!symbol-index-name">collections</a>
|
67 | </dt>
|
68 | <dd>
|
69 | </dd>
|
70 | <dt class="symbol-index-name">
|
71 | <a href="module-collections.html#~filter" class="!symbol-index-name">collections~<wbr>filter(fn, collection)</a>
|
72 | </dt>
|
73 | <dd>
|
74 | </dd>
|
75 | </dl>
|
76 | </div>
|
77 | <div class="symbol-index-column">
|
78 | <dl class="symbol-index-list">
|
79 | <dt class="symbol-index-name">
|
80 | <a href="module-collections.html#~map" class="!symbol-index-name">collections~<wbr>map(fn, collection)</a>
|
81 | </dt>
|
82 | <dd>
|
83 | </dd>
|
84 | <dt class="symbol-index-name">
|
85 | <a href="module-collections.html#~reduce" class="!symbol-index-name">collections~<wbr>reduce(fn, init, collection)</a>
|
86 | </dt>
|
87 | <dd>
|
88 | </dd>
|
89 | </dl>
|
90 | </div>
|
91 | <div class="symbol-index-column">
|
92 | <dl class="symbol-index-list">
|
93 | </dl>
|
94 | </div>
|
95 | </div>
|
96 | </div>
|
97 | </section>
|
98 | <section>
|
99 | <div class="symbol-index-content">
|
100 | <h2 id="concurrency">concurrency</h2>
|
101 | <div class="symbol-index-section">
|
102 | <div class="symbol-index-column">
|
103 | <dl class="symbol-index-list">
|
104 | <dt class="symbol-index-name">
|
105 | <a href="module-concurrency.html" class="!symbol-index-name">concurrency</a>
|
106 | </dt>
|
107 | <dd>
|
108 | </dd>
|
109 | </dl>
|
110 | </div>
|
111 | <div class="symbol-index-column">
|
112 | <dl class="symbol-index-list">
|
113 | <dt class="symbol-index-name">
|
114 | <a href="module-concurrency.html#~best" class="!symbol-index-name">concurrency~<wbr>best(promises)</a>
|
115 | </dt>
|
116 | <dd>
|
117 | </dd>
|
118 | </dl>
|
119 | </div>
|
120 | <div class="symbol-index-column">
|
121 | <dl class="symbol-index-list">
|
122 | <dt class="symbol-index-name">
|
123 | <a href="module-concurrency.html#~full" class="!symbol-index-name">concurrency~<wbr>full(promises)</a>
|
124 | </dt>
|
125 | <dd>
|
126 | </dd>
|
127 | </dl>
|
128 | </div>
|
129 | </div>
|
130 | </div>
|
131 | </section>
|
132 | <section>
|
133 | <div class="symbol-index-content">
|
134 | <h2 id="conversions">conversions</h2>
|
135 | <div class="symbol-index-section">
|
136 | <div class="symbol-index-column">
|
137 | <dl class="symbol-index-list">
|
138 | <dt class="symbol-index-name">
|
139 | <a href="module-conversions.html" class="!symbol-index-name">conversions</a>
|
140 | </dt>
|
141 | <dd>
|
142 | </dd>
|
143 | <dt class="symbol-index-name">
|
144 | <a href="module-conversions.html#~floatOr" class="!symbol-index-name">conversions~<wbr>floatOr(defaultValue, data)</a>
|
145 | </dt>
|
146 | <dd>
|
147 | </dd>
|
148 | </dl>
|
149 | </div>
|
150 | <div class="symbol-index-column">
|
151 | <dl class="symbol-index-list">
|
152 | <dt class="symbol-index-name">
|
153 | <a href="module-conversions.html#~intOr" class="!symbol-index-name">conversions~<wbr>intOr(defaultValue, data)</a>
|
154 | </dt>
|
155 | <dd>
|
156 | </dd>
|
157 | <dt class="symbol-index-name">
|
158 | <a href="module-conversions.html#~jsonOr" class="!symbol-index-name">conversions~<wbr>jsonOr(defaultValue, data)</a>
|
159 | </dt>
|
160 | <dd>
|
161 | </dd>
|
162 | </dl>
|
163 | </div>
|
164 | <div class="symbol-index-column">
|
165 | <dl class="symbol-index-list">
|
166 | <dt class="symbol-index-name">
|
167 | <a href="module-conversions.html#~parseOr" class="!symbol-index-name">conversions~<wbr>parseOr(parser, evaluator, defaultValue, data)</a>
|
168 | </dt>
|
169 | <dd>
|
170 | </dd>
|
171 | <dt class="symbol-index-name">
|
172 | <a href="module-conversions.html#~setPrecisionOr" class="!symbol-index-name">conversions~<wbr>setPrecisionOr(decimals, defaultValue, num)</a>
|
173 | </dt>
|
174 | <dd>
|
175 | </dd>
|
176 | </dl>
|
177 | </div>
|
178 | </div>
|
179 | </div>
|
180 | </section>
|
181 | <section>
|
182 | <div class="symbol-index-content">
|
183 | <h2 id="fp">fp</h2>
|
184 | <div class="symbol-index-section">
|
185 | <div class="symbol-index-column">
|
186 | <dl class="symbol-index-list">
|
187 | <dt class="symbol-index-name">
|
188 | <a href="module-fp.html" class="!symbol-index-name">fp</a>
|
189 | </dt>
|
190 | <dd>
|
191 | </dd>
|
192 | <dt class="symbol-index-name">
|
193 | <a href="module-fp.html#~compose" class="!symbol-index-name">fp~<wbr>compose(arguments)</a>
|
194 | </dt>
|
195 | <dd>
|
196 | </dd>
|
197 | </dl>
|
198 | </div>
|
199 | <div class="symbol-index-column">
|
200 | <dl class="symbol-index-list">
|
201 | <dt class="symbol-index-name">
|
202 | <a href="module-fp.html#~curry" class="!symbol-index-name">fp~<wbr>curry(function)</a>
|
203 | </dt>
|
204 | <dd>
|
205 | </dd>
|
206 | <dt class="symbol-index-name">
|
207 | <a href="module-fp.html#~mixCompose" class="!symbol-index-name">fp~<wbr>mixCompose(chain, func)</a>
|
208 | </dt>
|
209 | <dd>
|
210 | </dd>
|
211 | </dl>
|
212 | </div>
|
213 | <div class="symbol-index-column">
|
214 | <dl class="symbol-index-list">
|
215 | <dt class="symbol-index-name">
|
216 | <a href="module-fp.html#~pipe" class="!symbol-index-name">fp~<wbr>pipe(arguments)</a>
|
217 | </dt>
|
218 | <dd>
|
219 | </dd>
|
220 | </dl>
|
221 | </div>
|
222 | </div>
|
223 | </div>
|
224 | </section>
|
225 | <section>
|
226 | <div class="symbol-index-content">
|
227 | <h2 id="io">io</h2>
|
228 | <div class="symbol-index-section">
|
229 | <div class="symbol-index-column">
|
230 | <dl class="symbol-index-list">
|
231 | <dt class="symbol-index-name">
|
232 | <a href="module-io.html" class="!symbol-index-name">io</a>
|
233 | </dt>
|
234 | <dd>
|
235 | </dd>
|
236 | </dl>
|
237 | </div>
|
238 | <div class="symbol-index-column">
|
239 | <dl class="symbol-index-list">
|
240 | <dt class="symbol-index-name">
|
241 | <a href="module-io.html#~envOr" class="!symbol-index-name">io~<wbr>envOr(key, defaultValue, postProcessor, env)</a>
|
242 | </dt>
|
243 | <dd>
|
244 | </dd>
|
245 | </dl>
|
246 | </div>
|
247 | <div class="symbol-index-column">
|
248 | <dl class="symbol-index-list">
|
249 | </dl>
|
250 | </div>
|
251 | </div>
|
252 | </div>
|
253 | </section>
|
254 | <section>
|
255 | <div class="symbol-index-content">
|
256 | <h2 id="logic">logic</h2>
|
257 | <div class="symbol-index-section">
|
258 | <div class="symbol-index-column">
|
259 | <dl class="symbol-index-list">
|
260 | <dt class="symbol-index-name">
|
261 | <a href="module-logic.html" class="!symbol-index-name">logic</a>
|
262 | </dt>
|
263 | <dd>
|
264 | </dd>
|
265 | <dt class="symbol-index-name">
|
266 | <a href="module-logic.html#~either" class="!symbol-index-name">logic~<wbr>either(mainFn, failOver)</a>
|
267 | </dt>
|
268 | <dd>
|
269 | </dd>
|
270 | </dl>
|
271 | </div>
|
272 | <div class="symbol-index-column">
|
273 | <dl class="symbol-index-list">
|
274 | <dt class="symbol-index-name">
|
275 | <a href="module-logic.html#~fnOrValue" class="!symbol-index-name">logic~<wbr>fnOrValue(fnOrVal)</a>
|
276 | </dt>
|
277 | <dd>
|
278 | </dd>
|
279 | <dt class="symbol-index-name">
|
280 | <a href="module-logic.html#~identity" class="!symbol-index-name">logic~<wbr>identity(x)</a>
|
281 | </dt>
|
282 | <dd>
|
283 | </dd>
|
284 | </dl>
|
285 | </div>
|
286 | <div class="symbol-index-column">
|
287 | <dl class="symbol-index-list">
|
288 | <dt class="symbol-index-name">
|
289 | <a href="module-logic.html#~not" class="!symbol-index-name">logic~<wbr>not(fn)</a>
|
290 | </dt>
|
291 | <dd>
|
292 | </dd>
|
293 | </dl>
|
294 | </div>
|
295 | </div>
|
296 | </div>
|
297 | </section>
|
298 | <section>
|
299 | <div class="symbol-index-content">
|
300 | <h2 id="types">types</h2>
|
301 | <div class="symbol-index-section">
|
302 | <div class="symbol-index-column">
|
303 | <dl class="symbol-index-list">
|
304 | <dt class="symbol-index-name">
|
305 | <a href="module-types.html" class="!symbol-index-name">types</a>
|
306 | </dt>
|
307 | <dd>
|
308 | </dd>
|
309 | <dt class="symbol-index-name">
|
310 | <a href="module-types.html#~getFuncName" class="!symbol-index-name">types~<wbr>getFuncName([defaultValue])</a>
|
311 | </dt>
|
312 | <dd>
|
313 | </dd>
|
314 | </dl>
|
315 | </div>
|
316 | <div class="symbol-index-column">
|
317 | <dl class="symbol-index-list">
|
318 | <dt class="symbol-index-name">
|
319 | <a href="module-types.html#~isNil" class="!symbol-index-name">types~<wbr>isNil(num)</a>
|
320 | </dt>
|
321 | <dd>
|
322 | </dd>
|
323 | <dt class="symbol-index-name">
|
324 | <a href="module-types.html#~isNumber" class="!symbol-index-name">types~<wbr>isNumber(num)</a>
|
325 | </dt>
|
326 | <dd>
|
327 | </dd>
|
328 | </dl>
|
329 | </div>
|
330 | <div class="symbol-index-column">
|
331 | <dl class="symbol-index-list">
|
332 | <dt class="symbol-index-name">
|
333 | <a href="module-types.html#~isObject" class="!symbol-index-name">types~<wbr>isObject(num)</a>
|
334 | </dt>
|
335 | <dd>
|
336 | </dd>
|
337 | </dl>
|
338 | </div>
|
339 | </div>
|
340 | </div>
|
341 | </section>
|
342 | </div>
|
343 | </div>
|
344 | </div>
|
345 | <nav id="jsdoc-toc-nav" role="navigation"></nav>
|
346 | </div>
|
347 | </div>
|
348 | <footer id="jsdoc-footer" class="jsdoc-footer">
|
349 | <div id="jsdoc-footer-container">
|
350 | <p>
|
351 | Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.2 on June 17, 2019.
|
352 | </p>
|
353 | </div>
|
354 | </footer>
|
355 | <script src="scripts/jquery.min.js"></script>
|
356 | <script src="scripts/jquery.cookie.js"></script>
|
357 | <script src="scripts/tree.jquery.js"></script>
|
358 | <script src="scripts/prettify.js"></script>
|
359 | <script src="scripts/jsdoc-toc.js"></script>
|
360 | <script src="scripts/linenumber.js"></script>
|
361 | <script src="scripts/scrollanchor.js"></script>
|
362 | </body>
|
363 |
|
364 | </html> |
\ | No newline at end of file |