Darkhogg/polyethylene

View on GitHub
docs/polyethylene.poly.builder.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; [Poly](./polyethylene.poly.md) &gt; [builder](./polyethylene.poly.builder.md)

## Poly.builder() function

Return a new [AsyncIterableBuilder](./polyethylene.asynciterablebuilder.md)<!-- -->, an iterable object that can be constructed by calling its methods.

<b>Signature:</b>

```typescript
function builder<T>(): AsyncIterableBuilder<T>;
```
<b>Returns:</b>

AsyncIterableBuilder&lt;T&gt;

## Remarks

This method for creating iterables should only be used as last resort if other functions are not enough. In particular, before using this method, see if [Poly.buildWith()](./polyethylene.poly.buildwith.md) works for you.