Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Functor: add bindMap function as a do-notation helper #1725

Merged
merged 5 commits into from
Sep 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/modules/Array.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ Added in v2.0.0
- [insertAt](#insertat)
- [intercalate](#intercalate)
- [isOutOfBound](#isoutofbound)
- [let](#let)
- [lookup](#lookup)
- [modifyAt](#modifyat)
- [size](#size)
Expand Down Expand Up @@ -3513,6 +3514,19 @@ assert.strictEqual(isOutOfBound(3, ['a', 'b', 'c']), true)

Added in v2.0.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: A[]) => { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }[]
```

Added in v2.13.0

## lookup

This function provides a safe way to read a value at a particular index from an array.
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/Either.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ Added in v2.0.0
- [bindW](#bindw)
- [elem](#elem)
- [exists](#exists)
- [let](#let)
- [sequenceArray](#sequencearray)
- [toError](#toerror)
- [traverseArray](#traversearray)
Expand Down Expand Up @@ -1799,6 +1800,19 @@ assert.strictEqual(gt2(right(3)), true)

Added in v2.0.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <E>(fa: Either<E, A>) => Either<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## sequenceArray

**Signature**
Expand Down
65 changes: 65 additions & 0 deletions docs/modules/Functor.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Added in v2.0.0
- [Functor4 (interface)](#functor4-interface)
- [utils](#utils)
- [bindTo](#bindto)
- [let](#let)
- [let\_](#let_)
- [~~FunctorComposition11~~ (interface)](#functorcomposition11-interface)
- [~~FunctorComposition12C~~ (interface)](#functorcomposition12c-interface)
- [~~FunctorComposition12~~ (interface)](#functorcomposition12-interface)
Expand Down Expand Up @@ -248,6 +250,69 @@ export declare function bindTo<F>(

Added in v2.10.0

## let

**Signature**

```ts
export declare const let: typeof let_
```

Added in v2.13.0

## let\_

**Signature**

```ts
function let_<F extends URIS4>(
F: Functor4<F>
): <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <S, R, E>(
fa: Kind4<F, S, R, E, A>
) => Kind4<F, S, R, E, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }>
function let_<F extends URIS3>(
F: Functor3<F>
): <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <R, E>(fa: Kind3<F, R, E, A>) => Kind3<F, R, E, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }>
function let_<F extends URIS3, E>(
F: Functor3C<F, E>
): <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <R>(fa: Kind3<F, R, E, A>) => Kind3<F, R, E, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }>
function let_<F extends URIS2>(
F: Functor2<F>
): <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <E>(fa: Kind2<F, E, A>) => Kind2<F, E, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }>
function let_<F extends URIS2, E>(
F: Functor2C<F, E>
): <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: Kind2<F, E, A>) => Kind2<F, E, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }>
function let_<F extends URIS>(
F: Functor1<F>
): <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: Kind<F, A>) => Kind<F, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }>
function let_<F>(
F: Functor<F>
): <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: HKT<F, A>) => HKT<F, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## ~~FunctorComposition11~~ (interface)

**Signature**
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/IO.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Added in v2.0.0
- [apS](#aps)
- [bind](#bind)
- [bindTo](#bindto)
- [let](#let)
- [sequenceArray](#sequencearray)
- [traverseArray](#traversearray)
- [traverseArrayWithIndex](#traversearraywithindex)
Expand Down Expand Up @@ -429,6 +430,19 @@ export declare const bindTo: <N>(name: N) => <A>(fa: IO<A>) => IO<{ readonly [K

Added in v2.8.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: IO<A>) => IO<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## sequenceArray

**Signature**
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/IOEither.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ Added in v2.0.0
- [bindW](#bindw)
- [bracket](#bracket)
- [bracketW](#bracketw)
- [let](#let)
- [sequenceArray](#sequencearray)
- [sequenceSeqArray](#sequenceseqarray)
- [traverseArray](#traversearray)
Expand Down Expand Up @@ -1329,6 +1330,19 @@ export declare const bracketW: <E1, A, E2, B, E3>(

Added in v2.12.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <E>(fa: IOEither<E, A>) => IOEither<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## sequenceArray

**Signature**
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/IOOption.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ Added in v2.12.0
- [apS](#aps)
- [bind](#bind)
- [bindTo](#bindto)
- [let](#let)
- [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex)
- [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex)

Expand Down Expand Up @@ -876,6 +877,19 @@ export declare const bindTo: <N>(name: N) => <A>(fa: IOOption<A>) => IOOption<{

Added in v2.12.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: IOOption<A>) => IOOption<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## traverseReadonlyArrayWithIndex

**Signature**
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/Identity.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ Added in v2.0.0
- [apS](#aps)
- [bind](#bind)
- [bindTo](#bindto)
- [let](#let)
- [sequence](#sequence)
- [traverse](#traverse)

Expand Down Expand Up @@ -519,6 +520,19 @@ export declare const bindTo: <N>(name: N) => <A>(fa: A) => { readonly [K in N]:

Added in v2.8.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: A) => { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }
```

Added in v2.13.0

## sequence

**Signature**
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/NonEmptyArray.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ Added in v2.0.0
- [init](#init)
- [intercalate](#intercalate)
- [last](#last)
- [let](#let)
- [max](#max)
- [min](#min)
- [modifyHead](#modifyhead)
Expand Down Expand Up @@ -1463,6 +1464,19 @@ export declare const last: <A>(nea: NonEmptyArray<A>) => A

Added in v2.0.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: NonEmptyArray<A>) => NonEmptyArray<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## max

**Signature**
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/Option.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ Added in v2.0.0
- [bindTo](#bindto)
- [elem](#elem)
- [exists](#exists)
- [let](#let)
- [sequenceArray](#sequencearray)
- [traverseArray](#traversearray)
- [traverseArrayWithIndex](#traversearraywithindex)
Expand Down Expand Up @@ -1665,6 +1666,19 @@ assert.strictEqual(

Added in v2.0.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => (fa: Option<A>) => Option<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## sequenceArray

**Signature**
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/Reader.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ Added in v2.0.0
- [bind](#bind)
- [bindTo](#bindto)
- [bindW](#bindw)
- [let](#let)
- [sequenceArray](#sequencearray)
- [traverseArray](#traversearray)
- [traverseArrayWithIndex](#traversearraywithindex)
Expand Down Expand Up @@ -776,6 +777,19 @@ export declare const bindW: <N extends string, A, R2, B>(

Added in v2.8.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <E>(fa: Reader<E, A>) => Reader<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## sequenceArray

**Signature**
Expand Down
16 changes: 16 additions & 0 deletions docs/modules/ReaderEither.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ Added in v2.0.0
- [bind](#bind)
- [bindTo](#bindto)
- [bindW](#bindw)
- [let](#let)
- [sequenceArray](#sequencearray)
- [traverseArray](#traversearray)
- [traverseArrayWithIndex](#traversearraywithindex)
Expand Down Expand Up @@ -1355,6 +1356,21 @@ export declare const bindW: <N extends string, A, R2, E2, B>(

Added in v2.8.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <R, E>(
fa: ReaderEither<R, E, A>
) => ReaderEither<R, E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## sequenceArray

**Signature**
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/ReaderTask.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ Added in v2.3.0
- [bind](#bind)
- [bindTo](#bindto)
- [bindW](#bindw)
- [let](#let)
- [sequenceArray](#sequencearray)
- [traverseArray](#traversearray)
- [traverseArrayWithIndex](#traversearraywithindex)
Expand Down Expand Up @@ -822,6 +823,19 @@ export declare const bindW: <N extends string, A, R2, B>(

Added in v2.8.0

## let

**Signature**

```ts
export declare const let: <N, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B
) => <E>(fa: ReaderTask<E, A>) => ReaderTask<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
```

Added in v2.13.0

## sequenceArray

**Signature**
Expand Down
Loading