Skip to content

Commit

Permalink
chore: update some stuff and hopefully fix GitHub actions
Browse files Browse the repository at this point in the history
  • Loading branch information
Darkhogg committed Dec 2, 2024
1 parent ebcc8b1 commit 0ca10fd
Show file tree
Hide file tree
Showing 117 changed files with 6,553 additions and 997 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Cache pnpm modules
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: ~/.pnpm-store
key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-
- uses: pnpm/action-setup@v2.2.4
- uses: pnpm/action-setup@v4
with:
version: 8.6.3
version: 9.14.4
run_install: |
args: [--frozen-lockfile, --strict-peer-dependencies]
- run: pnpm run test
25 changes: 22 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,26 @@

## Packages

| Package | Description |
| --- | --- |
| [polyethylene](./polyethylene.md) | A library for working with iterables and async iterables in a functional style, by transforming the iterations on the fly and getting results from them. |
<table><thead><tr><th>

Package


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[polyethylene](./polyethylene.md)


</td><td>

A library for working with iterables and async iterables in a functional style, by transforming the iterations on the fly and getting results from them.


</td></tr>
</tbody></table>
35 changes: 32 additions & 3 deletions docs/polyethylene.asynciterablebuilder.error.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,39 @@ error(error: Error): void;

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| error | Error | The error to be thrown by the underlying iterable |
<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

error


</td><td>

Error


</td><td>

The error to be thrown by the underlying iterable


</td></tr>
</tbody></table>
**Returns:**

void
Expand Down
93 changes: 86 additions & 7 deletions docs/polyethylene.asynciterablebuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,90 @@ The constructor for this class is marked as internal. Third-party code should no
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [\[Symbol.asyncIterator\]()](./polyethylene.asynciterablebuilder._symbol.asynciterator_.md) | | Allows this class to work as a regular <code>AsyncIterable&lt;T&gt;</code> |
| [done()](./polyethylene.asynciterablebuilder.done.md) | | Makes the underlying iterable finish the iteration. |
| [error(error)](./polyethylene.asynciterablebuilder.error.md) | | Makes the underlying iterable throw the given <code>error</code> object. |
| [toPolyAsyncIterable()](./polyethylene.asynciterablebuilder.topolyasynciterable.md) | | Get a [PolyAsyncIterable](./polyethylene.polyasynciterable.md) that iterates the elements as determined by calls to <code>this</code> object's [value](./polyethylene.asynciterablebuilder.value.md)<!-- -->, [error](./polyethylene.asynciterablebuilder.error.md) and [done](./polyethylene.asynciterablebuilder.done.md) methods. |
| [value(obj)](./polyethylene.asynciterablebuilder.value.md) | | Gives the underlying iterable a new value to be yielded. |
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[\[Symbol.asyncIterator\]()](./polyethylene.asynciterablebuilder._symbol.asynciterator_.md)
</td><td>
</td><td>
Allows this class to work as a regular `AsyncIterable<T>`
</td></tr>
<tr><td>
[done()](./polyethylene.asynciterablebuilder.done.md)
</td><td>
</td><td>
Makes the underlying iterable finish the iteration.
</td></tr>
<tr><td>
[error(error)](./polyethylene.asynciterablebuilder.error.md)
</td><td>
</td><td>
Makes the underlying iterable throw the given `error` object.
</td></tr>
<tr><td>
[toPolyAsyncIterable()](./polyethylene.asynciterablebuilder.topolyasynciterable.md)
</td><td>
</td><td>
Get a [PolyAsyncIterable](./polyethylene.polyasynciterable.md) that iterates the elements as determined by calls to `this` object's [value](./polyethylene.asynciterablebuilder.value.md)<!-- -->, [error](./polyethylene.asynciterablebuilder.error.md) and [done](./polyethylene.asynciterablebuilder.done.md) methods.
</td></tr>
<tr><td>
[value(obj)](./polyethylene.asynciterablebuilder.value.md)
</td><td>
</td><td>
Gives the underlying iterable a new value to be yielded.
</td></tr>
</tbody></table>
35 changes: 32 additions & 3 deletions docs/polyethylene.asynciterablebuilder.value.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,39 @@ value(obj: T): void;

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| obj | T | The object to be yielded by the underlying iterable |
<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

obj


</td><td>

T


</td><td>

The object to be yielded by the underlying iterable


</td></tr>
</tbody></table>
**Returns:**

void
Expand Down
63 changes: 59 additions & 4 deletions docs/polyethylene.concurrencyoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,63 @@ export interface ConcurrencyOptions

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [bufferSize?](./polyethylene.concurrencyoptions.buffersize.md) | | number | _(Optional)_ Maximum amount of intermediate results to store (defaults to twice the concurrency value) |
| [concurrency?](./polyethylene.concurrencyoptions.concurrency.md) | | number | _(Optional)_ Maximum amount of promises to launch at the same time (defaults to 1) |
<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[bufferSize?](./polyethylene.concurrencyoptions.buffersize.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ Maximum amount of intermediate results to store (defaults to twice the concurrency value)


</td></tr>
<tr><td>

[concurrency?](./polyethylene.concurrencyoptions.concurrency.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ Maximum amount of promises to launch at the same time (defaults to 1)


</td></tr>
</tbody></table>
Loading

0 comments on commit 0ca10fd

Please sign in to comment.