# it-split
[](https://codecov.io/gh/achingbrain/it)
[](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
> Splits Uint8Arrays emitted by an (async) iterable by a delimiter
# About
Searches `Uint8Array`s emitted by an (async)iterable for a delimiter and yields chunks split by that delimiter.
## Example
```javascript
import split from 'it-split'
const encoder = new TextEncoder()
// This can also be an iterator, generator, etc
const values = [
encoder.encode('hello\nwor'),
encoder.encode('ld')
]
const arr = all(split(values))
console.info(arr) // [encoder.encode('hello'), encoder.encode('world')]
```
You can also split by arbitrary delimiters:
```javascript
const values = [
Uint8Array.from([0, 1, 2, 3]),
Uint8Array.from([0, 1, 2, 3]),
Uint8Array.from([1, 1, 2])
]
const delimiter = Uint8Array.from([1, 2])
const arr = all(split(values, {
delimiter
}))
console.info(arr) // [ Buffer.from([0]), Buffer.from([3, 0]), Buffer.from([3, 1]) ]
```
Async sources must be awaited:
```javascript
import split from 'it-split'
const encoder = new TextEncoder()
const values = async function * () {
yield * [
encoder.encode('hello\nwor'),
encoder.encode('ld')
]
}
const arr = await all(split(values()))
console.info(arr) // [encoder.encode('hello'), encoder.encode('world')]
```
# Install
```console
$ npm i it-split
```
## Browser `
```
# API Docs
-
# License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-split/LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-split/LICENSE-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.