{"id":19755044,"url":"https://github.com/stdlib-js/utils-async-none-by","last_synced_at":"2025-04-30T11:32:09.271Z","repository":{"id":41468057,"uuid":"376835183","full_name":"stdlib-js/utils-async-none-by","owner":"stdlib-js","description":"Test whether all elements in a collection fail a test implemented by a predicate function.","archived":false,"fork":false,"pushed_at":"2024-11-01T07:56:18.000Z","size":943,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-11T05:57:24.448Z","etag":null,"topics":["all","array-like","async","asynchronous","collection","every","iterate","javascript","node","node-js","nodejs","none","predicate","stdlib","test","util","utilities","utility","utils","validate"],"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-14T13:36:17.000Z","updated_at":"2024-11-01T03:33:42.000Z","dependencies_parsed_at":"2023-09-23T18:58:47.190Z","dependency_job_id":"f5f8a32d-2d71-45e5-8375-6ebd56f72952","html_url":"https://github.com/stdlib-js/utils-async-none-by","commit_stats":{"total_commits":56,"total_committers":2,"mean_commits":28.0,"dds":"0.017857142857142905","last_synced_commit":"042ff15927e0a2abcaf3e0ffa6588d33b4e3dd5f"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-async-none-by","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-async-none-by/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-async-none-by/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Futils-async-none-by/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/utils-async-none-by/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224208101,"owners_count":17273674,"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":["all","array-like","async","asynchronous","collection","every","iterate","javascript","node","node-js","nodejs","none","predicate","stdlib","test","util","utilities","utility","utils","validate"],"created_at":"2024-11-12T03:08:05.663Z","updated_at":"2025-04-30T11:32:09.239Z","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# noneByAsync\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 Test whether all elements in a collection fail a test implemented by a predicate function.\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-none-by\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 noneByAsync = require( '@stdlib/utils-async-none-by' );\n```\n\n#### noneByAsync( collection, \\[options,] predicate, done )\n\nTests whether all elements in a `collection` fail a test implemented by a `predicate` function.\n\n```javascript\nfunction predicate( value, next ) {\n    setTimeout( onTimeout, value );\n    function onTimeout() {\n        console.log( value );\n        /* =\u003e\n            1000\n            2500\n            3000\n        */\n\n        next( null, false );\n    }\n}\n\nfunction done( error, bool ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( bool );\n    // =\u003e true\n}\n\nvar arr = [ 3000, 2500, 1000 ];\n\nnoneByAsync( arr, predicate, done );\n```\n\nIf a `predicate` function calls the `next` callback with a truthy test argument, the function stops processing any additional `collection` elements and returns `false` for the test result.\n\n```javascript\nfunction predicate( value, index, next ) {\n    setTimeout( onTimeout, value );\n    function onTimeout() {\n        if ( index === 1 ) {\n            return next( null, true );\n        }\n        next( null, false );\n    }\n}\n\nfunction done( error, bool ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( bool );\n    // =\u003e false\n}\n\nvar arr = [ 3000, 2500, 1000 ];\n\nnoneByAsync( arr, predicate, done );\n```\n\nThe function accepts the following `options`:\n\n-   `limit`: the maximum number of pending invocations at any one time. Default: `infinity`.\n-   `series`: `boolean` indicating whether to sequentially invoke the `predicate` function for each `collection` element. If `true`, the function sets `options.limit=1`. Default: `false`.\n-   `thisArg`: the execution context for `predicate`.\n\nBy default, all elements are processed concurrently, which means that the function does **not** guarantee completion order. To process each `collection` element sequentially, set the `series` option to `true`.\n\n```javascript\nfunction predicate( value, next ) {\n    setTimeout( onTimeout, value );\n    function onTimeout() {\n        console.log( value );\n        /* =\u003e\n            3000\n            2500\n            1000\n        */\n\n        next( null, false );\n    }\n}\n\nfunction done( error, bool ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( bool );\n    // =\u003e true\n}\n\nvar arr = [ 3000, 2500, 1000 ];\n\nvar opts = {\n    'series': true\n};\n\nnoneByAsync( arr, opts, predicate, done );\n```\n\nTo limit the maximum number of pending function invocations, set the `limit` option.\n\n```javascript\nfunction predicate( value, next ) {\n    setTimeout( onTimeout, value );\n    function onTimeout() {\n        console.log( value );\n        /* =\u003e\n            2500\n            3000\n            1000\n        */\n\n        next( null, false );\n    }\n}\n\nfunction done( error, bool ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( bool );\n    // =\u003e true\n}\n\nvar arr = [ 3000, 2500, 1000 ];\n\nvar opts = {\n    'limit': 2\n};\n\nnoneByAsync( arr, opts, predicate, done );\n```\n\nTo set the execution context of the `predicate` function, set the `thisArg` option.\n\n```javascript\nfunction predicate( value, next ) {\n    this.count += 1;\n    setTimeout( onTimeout, value );\n    function onTimeout() {\n        next( null, false );\n    }\n}\n\nvar arr = [ 3000, 2500, 1000 ];\n\nvar context = {\n    'count': 0\n};\n\nvar opts = {\n    'thisArg': context\n};\n\nnoneByAsync( arr, opts, predicate, done );\n\nfunction done( error, bool ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( bool );\n    // =\u003e true\n\n    console.log( context.count );\n    // =\u003e 3\n}\n```\n\nWhen invoked, the `predicate` function is provided a maximum of four arguments:\n\n-   `value`: collection value.\n-   `index`: collection index.\n-   `collection`: the input `collection`.\n-   `next`: a callback which should be called once the `predicate` function has finished processing a collection `value`.\n\nThe actual number of provided arguments depends on function `length`. If the `predicate` function accepts two arguments, the `predicate` function is provided `value` and `next`. If the `predicate` function accepts three arguments, the `predicate` function is provided `value`, `index`, and `next`. For every other `predicate` function signature, the `predicate` function is provided all four arguments.\n\n```javascript\nfunction predicate( value, i, collection, next ) {\n    console.log( 'collection: %s. %d: %d', collection.join( ',' ), i, value );\n    /* =\u003e\n        collection: 3000,2500,1000. 0: 3000\n        collection: 3000,2500,1000. 1: 2500\n        collection: 3000,2500,1000. 2: 1000\n    */\n\n    setTimeout( onTimeout, value );\n    function onTimeout() {\n        console.log( value );\n        /* =\u003e\n            1000\n            2500\n            3000\n        */\n\n        next( null, false );\n    }\n}\n\nfunction done( error, bool ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( bool );\n    // =\u003e true\n}\n\nvar arr = [ 3000, 2500, 1000 ];\n\nnoneByAsync( arr, predicate, done );\n```\n\n#### noneByAsync.factory( \\[options,] predicate )\n\nReturns a `function` which invokes a `predicate` function once for each element in a `collection`.\n\n```javascript\nfunction predicate( value, next ) {\n    setTimeout( onTimeout, value );\n    function onTimeout() {\n        console.log( value );\n        next( null, false );\n    }\n}\n\nfunction done( error, bool ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( bool );\n}\n\nvar f = noneByAsync.factory( predicate );\n\nvar arr1 = [ 3000, 2500, 1000 ];\n\nf( arr1, done );\n/* e.g., =\u003e\n    1000\n    2500\n    3000\n    true\n*/\n\nvar arr2 = [ 300, 250, 100 ];\n\nf( arr2, done );\n/* e.g., =\u003e\n    100\n    250\n    300\n    true\n*/\n```\n\nThe function accepts the same `options` as `noneByAsync()`.\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-   A `collection` may be either an [`Array`][mdn-array], [`Typed Array`][mdn-typed-array], or an array-like [`Object`][mdn-object] (excluding `strings` and `functions`).\n-   If a provided function calls the `next` callback with a truthy `error` argument, the function suspends execution and immediately calls the `done` callback for subsequent `error` handling.\n-   The function does **not** support dynamic `collection` resizing.\n-   The function does **not** skip `undefined` elements.\n-   If provided an empty `collection`, the function calls the `done` callback with `true` as the test result.\n-   **Neither** `noneByAsync` nor the function returned by the `factory` method **guarantee** asynchronous execution. 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 no-undef: \"error\" --\u003e\n\n```javascript\nvar resolve = require( 'path' ).resolve;\nvar readFile = require( '@stdlib/fs-read-file' );\nvar noneByAsync = require( '@stdlib/utils-async-none-by' );\n\nvar files = [\n    resolve( __dirname, 'package.json' ),\n    resolve( __dirname, 'README.md' )\n];\n\nfunction done( error, bool ) {\n    if ( error ) {\n        throw error;\n    }\n    if ( bool ) {\n        console.log( 'Was unable to read all files.' );\n    } else {\n        console.log( 'Was able to read at least one file.' );\n    }\n}\n\nfunction predicate( file, next ) {\n    var opts = {\n        'encoding': 'utf8'\n    };\n    readFile( file, opts, onFile );\n\n    function onFile( error ) {\n        if ( error ) {\n            return next( null, false );\n        }\n        next( null, true );\n    }\n}\n\nnoneByAsync( files, predicate, done );\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/any-by`][@stdlib/utils/async/any-by]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003etest whether at least one element in a collection passes a test implemented by a predicate function.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-async/every-by`][@stdlib/utils/async/every-by]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003etest whether all elements in a collection pass a test implemented by a predicate function.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-async/for-each`][@stdlib/utils/async/for-each]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003einvoke a function once for each element in a collection.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-none-by`][@stdlib/utils/none-by]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003etest whether all elements in a collection fail a test implemented by a predicate function.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-async/none-by-right`][@stdlib/utils/async/none-by-right]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003etest whether all elements in a collection fail a test implemented by a predicate function, iterating from right to left.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/utils-async/some-by`][@stdlib/utils/async/some-by]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003etest whether a collection contains `n` elements which pass a test implemented by a predicate function.\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-2025. 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-none-by.svg\n[npm-url]: https://npmjs.org/package/@stdlib/utils-async-none-by\n\n[test-image]: https://github.com/stdlib-js/utils-async-none-by/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/utils-async-none-by/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-async-none-by/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/utils-async-none-by?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/utils-async-none-by.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/utils-async-none-by/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-none-by/tree/deno\n[deno-readme]: https://github.com/stdlib-js/utils-async-none-by/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/utils-async-none-by/tree/umd\n[umd-readme]: https://github.com/stdlib-js/utils-async-none-by/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/utils-async-none-by/tree/esm\n[esm-readme]: https://github.com/stdlib-js/utils-async-none-by/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/utils-async-none-by/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-none-by/main/LICENSE\n\n[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\n\n[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\n\n[mdn-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/utils/async/any-by]: https://github.com/stdlib-js/utils-async-any-by\n\n[@stdlib/utils/async/every-by]: https://github.com/stdlib-js/utils-async-every-by\n\n[@stdlib/utils/async/for-each]: https://github.com/stdlib-js/utils-async-for-each\n\n[@stdlib/utils/none-by]: https://github.com/stdlib-js/utils-none-by\n\n[@stdlib/utils/async/none-by-right]: https://github.com/stdlib-js/utils-async-none-by-right\n\n[@stdlib/utils/async/some-by]: https://github.com/stdlib-js/utils-async-some-by\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-none-by","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Futils-async-none-by","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Futils-async-none-by/lists"}