0d073fa89e
- Add GETTING_STARTED.md with quick start guide and development modes - Add INSTALL.sh automated installation script - Add INSTALLATION_CHECKLIST.md, INSTALLATION_SUCCESS.md, and INSTALLATION_SUMMARY.md - Add QUICK_REFERENCE.md for common commands - Add SETUP_GUIDE.md with detailed setup instructions - Update README.md with improved project overview - Add did-wallet app dependencies and node_modules
96 lines
2.4 KiB
Markdown
96 lines
2.4 KiB
Markdown
# it-peekable
|
|
|
|
[](https://codecov.io/gh/achingbrain/it)
|
|
[](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
|
|
|
|
> Allows peeking/pushing an iterable
|
|
|
|
# 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.
|
|
|
|
-->
|
|
|
|
Lets you look at the contents of an async iterator and decide what to do
|
|
|
|
## Example
|
|
|
|
```javascript
|
|
import peekable from 'it-peekable'
|
|
|
|
// This can also be an iterator, generator, etc
|
|
const values = [0, 1, 2, 3, 4]
|
|
|
|
const it = peekable(value)
|
|
|
|
const first = it.peek()
|
|
|
|
console.info(first) // 0
|
|
|
|
it.push(first)
|
|
|
|
console.info([...it])
|
|
// [ 0, 1, 2, 3, 4 ]
|
|
```
|
|
|
|
Async sources must be awaited:
|
|
|
|
```javascript
|
|
import peekable from 'it-peekable'
|
|
|
|
const values = async function * () {
|
|
yield * [0, 1, 2, 3, 4]
|
|
}
|
|
|
|
const it = peekable(values())
|
|
|
|
const first = await it.peek()
|
|
|
|
console.info(first) // 0
|
|
|
|
it.push(first)
|
|
|
|
console.info(await all(it))
|
|
// [ 0, 1, 2, 3, 4 ]
|
|
```
|
|
|
|
# Install
|
|
|
|
```console
|
|
$ npm i it-peekable
|
|
```
|
|
|
|
## Browser `<script>` tag
|
|
|
|
Loading this module through a script tag will make its exports available as `ItPeekable` in the global namespace.
|
|
|
|
```html
|
|
<script src="https://unpkg.com/it-peekable/dist/index.min.js"></script>
|
|
```
|
|
|
|
# API Docs
|
|
|
|
- <https://achingbrain.github.io/it/modules/it_peekable.html>
|
|
|
|
# License
|
|
|
|
Licensed under either of
|
|
|
|
- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-peekable/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
|
- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-peekable/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.
|