3.0.6 • Published 7 months ago
it-sort v3.0.6
it-sort
Collects all values from an async iterator, sorts them using the passed function and yields them
About
Consumes all values from an (async)iterable and returns them sorted by the passed sort function.
Example
import sort from 'it-sort'
import all from 'it-all'
const sorter = (a, b) => {
return a.localeCompare(b)
}
// This can also be an iterator, generator, etc
const values = ['foo', 'bar']
const arr = all(sort(values, sorter))
console.info(arr) // 'bar', 'foo'
Async sources must be awaited:
import sort from 'it-sort'
import all from 'it-all'
const sorter = (a, b) => {
return a.localeCompare(b)
}
const values = async function * () {
yield * ['foo', 'bar']
}
const arr = await all(sort(values, sorter))
console.info(arr) // 'bar', 'foo'
Install
$ npm i it-sort
Browser <script>
tag
Loading this module through a script tag will make it's exports available as ItSort
in the global namespace.
<script src="https://unpkg.com/it-sort/dist/index.min.js"></script>
API Docs
License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
- MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.