index.js (7437B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /* 22 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name. 23 */ 24 25 // MODULES // 26 27 var setReadOnly = require( './../../define-read-only-property' ); 28 29 30 // MAIN // 31 32 /** 33 * Top-level namespace. 34 * 35 * @namespace ns 36 */ 37 var ns = {}; 38 39 /** 40 * @name anyByAsync 41 * @memberof ns 42 * @readonly 43 * @type {Function} 44 * @see {@link module:@stdlib/utils/async/any-by} 45 */ 46 setReadOnly( ns, 'anyByAsync', require( './../../async/any-by' ) ); 47 48 /** 49 * @name anyByRightAsync 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/utils/async/any-by-right} 54 */ 55 setReadOnly( ns, 'anyByRightAsync', require( './../../async/any-by-right' ) ); 56 57 /** 58 * @name bifurcateByAsync 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/utils/async/bifurcate-by} 63 */ 64 setReadOnly( ns, 'bifurcateByAsync', require( './../../async/bifurcate-by' ) ); 65 66 /** 67 * @name composeAsync 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/utils/async/compose} 72 */ 73 setReadOnly( ns, 'composeAsync', require( './../../async/compose' ) ); 74 75 /** 76 * @name countByAsync 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/utils/async/count-by} 81 */ 82 setReadOnly( ns, 'countByAsync', require( './../../async/count-by' ) ); 83 84 /** 85 * @name doUntilAsync 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/utils/async/do-until} 90 */ 91 setReadOnly( ns, 'doUntilAsync', require( './../../async/do-until' ) ); 92 93 /** 94 * @name doWhileAsync 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/utils/async/do-while} 99 */ 100 setReadOnly( ns, 'doWhileAsync', require( './../../async/do-while' ) ); 101 102 /** 103 * @name everyByAsync 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/utils/async/every-by} 108 */ 109 setReadOnly( ns, 'everyByAsync', require( './../../async/every-by' ) ); 110 111 /** 112 * @name everyByRightAsync 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/utils/async/every-by-right} 117 */ 118 setReadOnly( ns, 'everyByRightAsync', require( './../../async/every-by-right' ) ); 119 120 /** 121 * @name forEachAsync 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/utils/async/for-each} 126 */ 127 setReadOnly( ns, 'forEachAsync', require( './../../async/for-each' ) ); 128 129 /** 130 * @name forEachRightAsync 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/utils/async/for-each-right} 135 */ 136 setReadOnly( ns, 'forEachRightAsync', require( './../../async/for-each-right' ) ); 137 138 /** 139 * @name functionSequenceAsync 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/utils/async/function-sequence} 144 */ 145 setReadOnly( ns, 'functionSequenceAsync', require( './../../async/function-sequence' ) ); 146 147 /** 148 * @name groupByAsync 149 * @memberof ns 150 * @readonly 151 * @type {Function} 152 * @see {@link module:@stdlib/utils/async/group-by} 153 */ 154 setReadOnly( ns, 'groupByAsync', require( './../../async/group-by' ) ); 155 156 /** 157 * @name ifelseAsync 158 * @memberof ns 159 * @readonly 160 * @type {Function} 161 * @see {@link module:@stdlib/utils/async/if-else} 162 */ 163 setReadOnly( ns, 'ifelseAsync', require( './../../async/if-else' ) ); 164 165 /** 166 * @name ifthenAsync 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/utils/async/if-then} 171 */ 172 setReadOnly( ns, 'ifthenAsync', require( './../../async/if-then' ) ); 173 174 /** 175 * @name inmapAsync 176 * @memberof ns 177 * @readonly 178 * @type {Function} 179 * @see {@link module:@stdlib/utils/async/inmap} 180 */ 181 setReadOnly( ns, 'inmapAsync', require( './../../async/inmap' ) ); 182 183 /** 184 * @name inmapRightAsync 185 * @memberof ns 186 * @readonly 187 * @type {Function} 188 * @see {@link module:@stdlib/utils/async/inmap-right} 189 */ 190 setReadOnly( ns, 'inmapRightAsync', require( './../../async/inmap-right' ) ); 191 192 /** 193 * @name mapFunAsync 194 * @memberof ns 195 * @readonly 196 * @type {Function} 197 * @see {@link module:@stdlib/utils/async/map-function} 198 */ 199 setReadOnly( ns, 'mapFunAsync', require( './../../async/map-function' ) ); 200 201 /** 202 * @name mapKeysAsync 203 * @memberof ns 204 * @readonly 205 * @type {Function} 206 * @see {@link module:@stdlib/utils/async/map-keys} 207 */ 208 setReadOnly( ns, 'mapKeysAsync', require( './../../async/map-keys' ) ); 209 210 /** 211 * @name mapValuesAsync 212 * @memberof ns 213 * @readonly 214 * @type {Function} 215 * @see {@link module:@stdlib/utils/async/map-values} 216 */ 217 setReadOnly( ns, 'mapValuesAsync', require( './../../async/map-values' ) ); 218 219 /** 220 * @name noneByAsync 221 * @memberof ns 222 * @readonly 223 * @type {Function} 224 * @see {@link module:@stdlib/utils/async/none-by} 225 */ 226 setReadOnly( ns, 'noneByAsync', require( './../../async/none-by' ) ); 227 228 /** 229 * @name noneByRightAsync 230 * @memberof ns 231 * @readonly 232 * @type {Function} 233 * @see {@link module:@stdlib/utils/async/none-by-right} 234 */ 235 setReadOnly( ns, 'noneByRightAsync', require( './../../async/none-by-right' ) ); 236 237 /** 238 * @name reduceAsync 239 * @memberof ns 240 * @readonly 241 * @type {Function} 242 * @see {@link module:@stdlib/utils/async/reduce} 243 */ 244 setReadOnly( ns, 'reduceAsync', require( './../../async/reduce' ) ); 245 246 /** 247 * @name reduceRightAsync 248 * @memberof ns 249 * @readonly 250 * @type {Function} 251 * @see {@link module:@stdlib/utils/async/reduce-right} 252 */ 253 setReadOnly( ns, 'reduceRightAsync', require( './../../async/reduce-right' ) ); 254 255 /** 256 * @name waterfall 257 * @memberof ns 258 * @readonly 259 * @type {Function} 260 * @see {@link module:@stdlib/utils/async/series-waterfall} 261 */ 262 setReadOnly( ns, 'waterfall', require( './../../async/series-waterfall' ) ); 263 264 /** 265 * @name someByAsync 266 * @memberof ns 267 * @readonly 268 * @type {Function} 269 * @see {@link module:@stdlib/utils/async/some-by} 270 */ 271 setReadOnly( ns, 'someByAsync', require( './../../async/some-by' ) ); 272 273 /** 274 * @name someByRightAsync 275 * @memberof ns 276 * @readonly 277 * @type {Function} 278 * @see {@link module:@stdlib/utils/async/some-by-right} 279 */ 280 setReadOnly( ns, 'someByRightAsync', require( './../../async/some-by-right' ) ); 281 282 /** 283 * @name tabulateByAsync 284 * @memberof ns 285 * @readonly 286 * @type {Function} 287 * @see {@link module:@stdlib/utils/async/tabulate-by} 288 */ 289 setReadOnly( ns, 'tabulateByAsync', require( './../../async/tabulate-by' ) ); 290 291 /** 292 * @name trycatchAsync 293 * @memberof ns 294 * @readonly 295 * @type {Function} 296 * @see {@link module:@stdlib/utils/async/try-catch} 297 */ 298 setReadOnly( ns, 'trycatchAsync', require( './../../async/try-catch' ) ); 299 300 /** 301 * @name trythenAsync 302 * @memberof ns 303 * @readonly 304 * @type {Function} 305 * @see {@link module:@stdlib/utils/async/try-then} 306 */ 307 setReadOnly( ns, 'trythenAsync', require( './../../async/try-then' ) ); 308 309 /** 310 * @name untilAsync 311 * @memberof ns 312 * @readonly 313 * @type {Function} 314 * @see {@link module:@stdlib/utils/async/until} 315 */ 316 setReadOnly( ns, 'untilAsync', require( './../../async/until' ) ); 317 318 /** 319 * @name whileAsync 320 * @memberof ns 321 * @readonly 322 * @type {Function} 323 * @see {@link module:@stdlib/utils/async/while} 324 */ 325 setReadOnly( ns, 'whileAsync', require( './../../async/while' ) ); 326 327 328 // EXPORTS // 329 330 module.exports = ns;