Darkhogg/polyethylene

View on GitHub
docs/polyethylene.asynciterablebuilder.error.md

Summary

Maintainability
Test Coverage
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [polyethylene](./polyethylene.md) &gt; [AsyncIterableBuilder](./polyethylene.asynciterablebuilder.md) &gt; [error](./polyethylene.asynciterablebuilder.error.md)

## AsyncIterableBuilder.error() method

Makes the underlying iterable throw the given `error` object.

<b>Signature:</b>

```typescript
error(error: Error): void;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  error | Error | The error to be thrown by the underlying iterable |

<b>Returns:</b>

void

## Remarks

Any values that were given with  will be yielded before the error is thrown.

Calling  or  after calling this method or calling this method after calling  will act as a no-op.