Darkhogg/polyethylene

View on GitHub
docs/polyethylene.poly.asyncfrom.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; [asyncFrom](./polyethylene.poly.asyncfrom.md)

## Poly.asyncFrom() function

Create a new [PolyAsyncIterable](./polyethylene.polyasynciterable.md) object from an iterable, async iterable, or a function that returns iterables (such as a generator function or an async generator function).

If the passed argument is a function, it will be called with no arguments and its return value will be used to create the resulting [PolyAsyncIterable](./polyethylene.polyasynciterable.md)<!-- -->.

<b>Signature:</b>

```typescript
function asyncFrom<T>(iterableOrFactory: Iterable<T> | IterableFactory<T> | AsyncIterable<T> | AsyncIterableFactory<T>): PolyAsyncIterable<T>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  iterableOrFactory | Iterable&lt;T&gt; \| [IterableFactory](./polyethylene.poly.iterablefactory.md)<!-- -->&lt;T&gt; \| AsyncIterable&lt;T&gt; \| [AsyncIterableFactory](./polyethylene.poly.asynciterablefactory.md)<!-- -->&lt;T&gt; | an async iterable or async iterable factory used to create the resulting async iterable |

<b>Returns:</b>

PolyAsyncIterable&lt;T&gt;

A [PolyAsyncIterable](./polyethylene.polyasynciterable.md) that iterates over the same elements as the passed iterable