feat: as and asUnit

gcanti · May 19, 2023 · 75920e8 · 75920e8
1 parent be3acab
commit 75920e8
Show file tree

Hide file tree

Showing 40 changed files with 787 additions and 13 deletions.
diff --git a/docs/modules/Either.ts.md b/docs/modules/Either.ts.md
@@ -147,6 +147,8 @@ Added in v2.0.0
   - [liftNullable](#liftnullable)
   - [liftOption](#liftoption)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [bimap](#bimap)
   - [flap](#flap)
   - [map](#map)
@@ -1306,6 +1308,33 @@ Added in v2.15.0
 
 # mapping
 
+## as
+
+Maps the `Right` value of this `Either` to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: {
+  <E, A, _>(self: Either<E, _>, a: A): Either<E, A>
+  <A>(a: A): <E, _>(self: Either<E, _>) => Either<E, A>
+}
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the `Right` value of this `Either` to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <E, _>(self: Either<E, _>) => Either<E, void>
+```
+
+Added in v2.16.0
+
 ## bimap
 
 Map a pair of functions over the two type arguments of the bifunctor.

diff --git a/docs/modules/IO.ts.md b/docs/modules/IO.ts.md
@@ -48,6 +48,8 @@ Added in v2.0.0
   - [chain](#chain)
   - [chainFirst](#chainfirst)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [flap](#flap)
   - [map](#map)
 - [model](#model)
@@ -288,6 +290,30 @@ Added in v2.0.0
 
 # mapping
 
+## as
+
+Maps the value to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: { <A, _>(self: IO<_>, a: A): IO<A>; <A>(a: A): <_>(self: IO<_>) => IO<A> }
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the value to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <_>(self: IO<_>) => IO<void>
+```
+
+Added in v2.16.0
+
 ## flap
 
 **Signature**

diff --git a/docs/modules/IOEither.ts.md b/docs/modules/IOEither.ts.md
@@ -98,6 +98,8 @@ Added in v2.0.0
   - [liftNullable](#liftnullable)
   - [liftOption](#liftoption)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [bimap](#bimap)
   - [flap](#flap)
   - [map](#map)
@@ -1069,6 +1071,33 @@ Added in v2.15.0
 
 # mapping
 
+## as
+
+Maps the `Right` value of this `IOEither` to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: {
+  <E, A, _>(self: IOEither<E, _>, a: A): IOEither<E, A>
+  <A>(a: A): <E, _>(self: IOEither<E, _>) => IOEither<E, A>
+}
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the `Right` value of this `IOEither` to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <E, _>(self: IOEither<E, _>) => IOEither<E, void>
+```
+
+Added in v2.16.0
+
 ## bimap
 
 Map a pair of functions over the two type arguments of the bifunctor.

diff --git a/docs/modules/IOOption.ts.md b/docs/modules/IOOption.ts.md
@@ -79,6 +79,8 @@ Added in v2.12.0
   - [fromOptionK](#fromoptionk)
   - [fromPredicate](#frompredicate)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [flap](#flap)
   - [map](#map)
 - [model](#model)
@@ -760,6 +762,33 @@ Added in v2.12.0
 
 # mapping
 
+## as
+
+Maps the `Some` value of this `IOOption` to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: {
+  <A, _>(self: IOOption<_>, a: A): IOOption<A>
+  <A>(a: A): <_>(self: IOOption<_>) => IOOption<A>
+}
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the `Some` value of this `IOOption` to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <_>(self: IOOption<_>) => IOOption<void>
+```
+
+Added in v2.16.0
+
 ## flap
 
 **Signature**

diff --git a/docs/modules/Option.ts.md b/docs/modules/Option.ts.md
@@ -144,6 +144,8 @@ Added in v2.0.0
   - [fromNullableK](#fromnullablek)
   - [fromPredicate](#frompredicate)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [flap](#flap)
   - [map](#map)
 - [model](#model)
@@ -1151,6 +1153,30 @@ Added in v2.0.0
 
 # mapping
 
+## as
+
+Maps the `Some` value of this `Option` to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: { <A, _>(self: Option<_>, a: A): Option<A>; <A>(a: A): <_>(self: Option<_>) => Option<A> }
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the `Some` value of this `Option` to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <_>(self: Option<_>) => Option<void>
+```
+
+Added in v2.16.0
+
 ## flap
 
 **Signature**

diff --git a/docs/modules/ReaderEither.ts.md b/docs/modules/ReaderEither.ts.md
@@ -88,6 +88,8 @@ Added in v2.0.0
   - [liftNullable](#liftnullable)
   - [liftOption](#liftoption)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [bimap](#bimap)
   - [flap](#flap)
   - [map](#map)
@@ -1040,6 +1042,33 @@ Added in v2.15.0
 
 # mapping
 
+## as
+
+Maps the `Right` value of this `ReaderEither` to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: {
+  <R, E, A, _>(self: ReaderEither<R, E, _>, a: A): ReaderEither<R, E, A>
+  <A>(a: A): <R, E, _>(self: ReaderEither<R, E, _>) => ReaderEither<R, E, A>
+}
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the `Right` value of this `ReaderEither` to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <R, E, _>(self: ReaderEither<R, E, _>) => ReaderEither<R, E, void>
+```
+
+Added in v2.16.0
+
 ## bimap
 
 Map a pair of functions over the two last type arguments of the bifunctor.

diff --git a/docs/modules/ReaderIO.ts.md b/docs/modules/ReaderIO.ts.md
@@ -51,6 +51,8 @@ Added in v2.13.0
   - [fromIOK](#fromiok)
   - [fromReaderK](#fromreaderk)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [flap](#flap)
   - [map](#map)
 - [model](#model)
@@ -487,6 +489,33 @@ Added in v2.13.0
 
 # mapping
 
+## as
+
+Maps the value to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: {
+  <R, A, _>(self: ReaderIO<R, _>, a: A): ReaderIO<R, A>
+  <A>(a: A): <R, _>(self: ReaderIO<R, _>) => ReaderIO<R, A>
+}
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the value to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <R, _>(self: ReaderIO<R, _>) => ReaderIO<R, void>
+```
+
+Added in v2.16.0
+
 ## flap
 
 **Signature**

diff --git a/docs/modules/ReaderTask.ts.md b/docs/modules/ReaderTask.ts.md
@@ -60,6 +60,8 @@ Added in v2.3.0
   - [fromReaderK](#fromreaderk)
   - [fromTaskK](#fromtaskk)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [flap](#flap)
   - [map](#map)
 - [model](#model)
@@ -620,6 +622,33 @@ Added in v2.4.0
 
 # mapping
 
+## as
+
+Maps the value to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: {
+  <R, A, _>(self: ReaderTask<R, _>, a: A): ReaderTask<R, A>
+  <A>(a: A): <R, _>(self: ReaderTask<R, _>) => ReaderTask<R, A>
+}
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the value to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <R, _>(self: ReaderTask<R, _>) => ReaderTask<R, void>
+```
+
+Added in v2.16.0
+
 ## flap
 
 **Signature**

diff --git a/docs/modules/ReaderTaskEither.ts.md b/docs/modules/ReaderTaskEither.ts.md
@@ -120,6 +120,8 @@ Added in v2.0.0
   - [liftNullable](#liftnullable)
   - [liftOption](#liftoption)
 - [mapping](#mapping)
+  - [as](#as)
+  - [asUnit](#asunit)
   - [bimap](#bimap)
   - [flap](#flap)
   - [map](#map)
@@ -1503,6 +1505,33 @@ Added in v2.15.0
 
 # mapping
 
+## as
+
+Maps the `Right` value of this `ReaderTaskEither` to the specified constant value.
+
+**Signature**
+
+```ts
+export declare const as: {
+  <R, E, A, _>(self: ReaderTaskEither<R, E, _>, a: A): ReaderTaskEither<R, E, A>
+  <A>(a: A): <R, E, _>(self: ReaderTaskEither<R, E, _>) => ReaderTaskEither<R, E, A>
+}
+```
+
+Added in v2.16.0
+
+## asUnit
+
+Maps the `Right` value of this `ReaderTaskEither` to the void constant value.
+
+**Signature**
+
+```ts
+export declare const asUnit: <R, E, _>(self: ReaderTaskEither<R, E, _>) => ReaderTaskEither<R, E, void>
+```
+
+Added in v2.16.0
+
 ## bimap
 
 Map a pair of functions over the two last type arguments of the bifunctor.