{"id":17716352,"url":"https://github.com/stdlib-js/utils-async-if-else","last_synced_at":"2025-04-21T03:32:19.572Z","repository":{"id":41356679,"uuid":"376624450","full_name":"stdlib-js/utils-async-if-else","owner":"stdlib-js","description":"If a predicate function returns a truthy value, return `x`; otherwise, return `y`.","archived":false,"fork":false,"pushed_at":"2024-10-01T02:42:52.000Z","size":976,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-05T20:44:21.761Z","etag":null,"topics":["async","asynchronous","condition","conditional","control","either-or","else","flow","if","if-else","javascript","node","node-js","nodejs","stdlib","util","utilities","utility","utils"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-13T19:27:30.000Z","updated_at":"2024-10-01T01:24:13.000Z","dependencies_parsed_at":"2023-10-05T08:13:48.999Z","dependency_job_id":"a970603a-1963-41cd-8667-a4d2d26049c1","html_url":"https://github.com/stdlib-js/utils-async-if-else","commit_stats":{"total_commits":49,"total_committers":1,"mean_commits":49.0,"dds":0.0,"last_synced_commit":"72ec305d00e0379396c59d911d3a0deec85e06ea"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-async-if-else","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-async-if-else/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-async-if-else/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-async-if-else/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/utils-async-if-else/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223849432,"owners_count":17213640,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","asynchronous","condition","conditional","control","either-or","else","flow","if","if-else","javascript","node","node-js","nodejs","stdlib","util","utilities","utility","utils"],"created_at":"2024-10-25T13:11:55.700Z","updated_at":"2024-11-09T16:01:27.276Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.\u003c/p\u003e\n  \u003cp\u003eThe library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.\u003c/p\u003e\n  \u003cp\u003eWhen you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# ifelseAsync\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e If a predicate function returns a truthy value, return `x`; otherwise, return `y`.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/utils-async-if-else\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar ifelseAsync = require( '@stdlib/utils-async-if-else' );\n```\n\n#### ifelseAsync( predicate, x, y, done )\n\nIf a `predicate` function returns a truthy value, returns `x`; otherwise, returns `y`.\n\n```javascript\nvar randu = require( '@stdlib/random-base-randu' );\n\nfunction predicate( clbk ) {\n    setTimeout( onTimeout, 0 );\n    function onTimeout() {\n        clbk( null, randu() \u003e 0.5 );\n    }\n}\n\nfunction done( error, result ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( result );\n}\n\nifelseAsync( predicate, 1.0, -1.0, done );\n```\n\nThe `predicate` function is provided a single argument:\n\n-   `clbk`: callback to invoke upon `predicate` function completion\n\nThe callback accepts two arguments:\n\n-   `error`: error object\n-   `bool`: condition used to determine whether to return `x` or `y`\n\nThe `done` callback is invoked upon function completion and is provided at most two arguments:\n\n-   `error`: error object\n-   `result`: either `x` or `y`\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   Execution is **not** guaranteed to be asynchronous. To guarantee asynchrony, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint-disable callback-return --\u003e\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar randu = require( '@stdlib/random-base-randu' );\nvar ifelseAsync = require( '@stdlib/utils-async-if-else' );\n\nvar i;\n\nfunction next() {\n    ifelseAsync( predicate, 'BOOP', 'beep', done );\n}\n\nfunction predicate( clbk ) {\n    setTimeout( onTimeout, 0 );\n    function onTimeout() {\n        clbk( null, randu() \u003e 0.9 );\n    }\n}\n\nfunction done( error, result ) {\n    if ( error ) {\n        throw error;\n    }\n    i += 1;\n    console.log( result );\n    if ( i \u003c 100 ) {\n        return next();\n    }\n}\n\ni = 0;\nnext();\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-async/if-then`][@stdlib/utils/async/if-then]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eif a predicate function returns a truthy value, invoke `x`; otherwise, invoke `y`.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-if-else`][@stdlib/utils/if-else]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eif a condition is truthy, return `x`; otherwise, return `y`.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.\n\nFor more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2024. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-async-if-else.svg\n[npm-url]: https://npmjs.org/package/@stdlib/utils-async-if-else\n\n[test-image]: https://github.com/stdlib-js/utils-async-if-else/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/utils-async-if-else/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-async-if-else/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/utils-async-if-else?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/utils-async-if-else.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/utils-async-if-else/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/utils-async-if-else/tree/deno\n[deno-readme]: https://github.com/stdlib-js/utils-async-if-else/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/utils-async-if-else/tree/umd\n[umd-readme]: https://github.com/stdlib-js/utils-async-if-else/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/utils-async-if-else/tree/esm\n[esm-readme]: https://github.com/stdlib-js/utils-async-if-else/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/utils-async-if-else/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-if-else/main/LICENSE\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/utils/async/if-then]: https://github.com/stdlib-js/utils-async-if-then\n\n[@stdlib/utils/if-else]: https://github.com/stdlib-js/utils-if-else\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Futils-async-if-else","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Futils-async-if-else","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Futils-async-if-else/lists"}