Darkhogg/polyethylene

View on GitHub
docs/polyethylene.polysynciterable.drop.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; [PolySyncIterable](./polyethylene.polysynciterable.md) &gt; [drop](./polyethylene.polysynciterable.drop.md)

## PolySyncIterable.drop() method

Return a new iteration that skips the first `num` elements. If there were less than `num` elements in the iteration, no elements are yielded.

<b>Signature:</b>

```typescript
drop(num?: number): PolySyncIterable<T>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  num | number | The number of elements to skip |

<b>Returns:</b>

PolySyncIterable&lt;T&gt;

a new [PolySyncIterable](./polyethylene.polysynciterable.md) that yields the same the elements of `this`<!-- -->, except for the first `num` elements