82 lines
2.1 KiB
Markdown
82 lines
2.1 KiB
Markdown
|
# it-first
|
||
|
|
|
||
|
|
[](https://codecov.io/gh/achingbrain/it)
|
||
|
|
[](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
|
||
|
|
|
||
|
|
> Returns the first result from an async iterator
|
||
|
|
|
||
|
|
# About
|
||
|
|
|
||
|
|
<!--
|
||
|
|
|
||
|
|
!IMPORTANT!
|
||
|
|
|
||
|
|
Everything in this README between "# About" and "# Install" is automatically
|
||
|
|
generated and will be overwritten the next time the doc generator is run.
|
||
|
|
|
||
|
|
To make changes to this section, please update the @packageDocumentation section
|
||
|
|
of src/index.js or src/index.ts
|
||
|
|
|
||
|
|
To experiment with formatting, please run "npm run docs" from the root of this
|
||
|
|
repo and examine the changes made.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
Return the first value in an (async)iterable
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import first from 'it-first'
|
||
|
|
|
||
|
|
// This can also be an iterator, generator, etc
|
||
|
|
const values = [0, 1, 2, 3, 4]
|
||
|
|
|
||
|
|
const res = first(values)
|
||
|
|
|
||
|
|
console.info(res) // 0
|
||
|
|
```
|
||
|
|
|
||
|
|
Async sources must be awaited:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import first from 'it-first'
|
||
|
|
|
||
|
|
const values = async function * () {
|
||
|
|
yield * [0, 1, 2, 3, 4]
|
||
|
|
}
|
||
|
|
|
||
|
|
const res = await first(values())
|
||
|
|
|
||
|
|
console.info(res) // 0
|
||
|
|
```
|
||
|
|
|
||
|
|
# Install
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ npm i it-first
|
||
|
|
```
|
||
|
|
|
||
|
|
## Browser `<script>` tag
|
||
|
|
|
||
|
|
Loading this module through a script tag will make its exports available as `ItFirst` in the global namespace.
|
||
|
|
|
||
|
|
```html
|
||
|
|
<script src="https://unpkg.com/it-first/dist/index.min.js"></script>
|
||
|
|
```
|
||
|
|
|
||
|
|
# API Docs
|
||
|
|
|
||
|
|
- <https://achingbrain.github.io/it/modules/it_first.html>
|
||
|
|
|
||
|
|
# License
|
||
|
|
|
||
|
|
Licensed under either of
|
||
|
|
|
||
|
|
- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-first/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
||
|
|
- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-first/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.
|