Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
velocityzen committed May 7, 2024
1 parent dd1cd73 commit f39b01f
Show file tree
Hide file tree
Showing 8 changed files with 108 additions and 7 deletions.
67 changes: 67 additions & 0 deletions docs/modules/AsyncGenerator.ts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: AsyncGenerator.ts
nav_order: 1
parent: Modules
---

## AsyncGenerator overview

The AsyncGenerator module provides tools for working with AsyncGenerator<T> type in a functional way.

In functional jargon, this module provides a monadic interface over AsyncGenerator<T>.

Added in v1.0.0

---

<h2 class="text-delta">Table of contents</h2>

- [conversions](#conversions)
- [fromAsyncIterable](#fromasynciterable)
- [fromIterable](#fromiterable)
- [fromLazyArg](#fromlazyarg)
- [fromTask](#fromtask)

---

# conversions

## fromAsyncIterable

**Signature**

```ts
export declare function fromAsyncIterable<A>(fa: AsyncIterable<A>): AsyncGenerator<A>
```

Added in v1.0.0

## fromIterable

**Signature**

```ts
export declare function fromIterable<A>(fa: Iterable<A>): LazyArg<AsyncGenerator<A>>
```

Added in v1.0.0

## fromLazyArg

**Signature**

```ts
export declare function fromLazyArg<A, R, N>(f: () => A): AsyncGenerator<A, R, N>
```

Added in v1.0.0

## fromTask

**Signature**

```ts
export declare function fromTask<A>(f: Task<A>): AsyncGenerator<A>
```

Added in v1.0.0
4 changes: 2 additions & 2 deletions docs/modules/AsyncIterable.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AsyncIterable.ts
nav_order: 1
nav_order: 2
parent: Modules
---

Expand Down Expand Up @@ -277,7 +277,7 @@ Added in v1.0.0
**Signature**
```ts
export declare function fromAsyncGenerator<A, R, N>(fa: () => AsyncGenerator<A, R, N>)
export declare function fromAsyncGenerator<A, R, N>(fa: LazyArg<AsyncGenerator<A, R, N>>)
```

Added in v1.0.0
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/AsyncIterableEither.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AsyncIterableEither.ts
nav_order: 2
nav_order: 3
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/AsyncIterableOption.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AsyncIterableOption.ts
nav_order: 3
nav_order: 4
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/AsyncIterableReduce.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AsyncIterableReduce.ts
nav_order: 4
nav_order: 5
parent: Modules
---

Expand Down
34 changes: 34 additions & 0 deletions docs/modules/Generator.ts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Generator.ts
nav_order: 6
parent: Modules
---

## Generator overview

The Generator module provides tools for working with Generator<T> type in a functional way.

In functional jargon, this module provides a monadic interface over Generator<T>.

Added in v1.0.0

---

<h2 class="text-delta">Table of contents</h2>

- [conversions](#conversions)
- [fromIterable](#fromiterable)

---

# conversions

## fromIterable

**Signature**

```ts
export declare function fromIterable<A>(fa: Iterable<A>): Generator<A>
```

Added in v1.0.0
2 changes: 1 addition & 1 deletion docs/modules/Iterable.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Iterable.ts
nav_order: 6
nav_order: 8
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/index.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: index.ts
nav_order: 5
nav_order: 7
parent: Modules
---

Expand Down

0 comments on commit f39b01f

Please sign in to comment.