version 2.6.3

CHANGELOG.md

@@ -14,6 +14,16 @@
 **Note**: Gaps between patch versions are faulty/broken releases. **Note**: A feature tagged as Experimental is in a
 high state of flux, you're at risk of it changing without notice.
 
+# 2.6.3
+
+- **Polish**
+  - change `ReadonlyNonEmptyArray` definition to get better type inference (@gcanti)
+  - move `pipe` to `function` module (@gcanti)
+  - export `sequence` from all modules which admit a `Traversable` instance (@gcanti)
+  - export a pipeable `traverse` function from all modules which admit a `Traversable` instance (@gcanti)
+  - export a pipeable `traverseWithIndex` function from all modules which admit a `TraversableWithIndex` instance (@gcanti)
+  - remove monad transformers imports from all modules (@gcanti)
+
 # 2.6.2
 
 The goal of this release is to make `fp-ts` more "tree shaking" friendly.

docs/modules/Array.ts.md

@@ -119,7 +119,10 @@ Added in v2.0.0
   - [isOutOfBound](#isoutofbound)
   - [lookup](#lookup)
   - [modifyAt](#modifyat)
+  - [sequence](#sequence)
   - [splitAt](#splitat)
+  - [traverse](#traverse)
+  - [traverseWithIndex](#traversewithindex)
   - [unzip](#unzip)
   - [updateAt](#updateat)
 
@@ -1768,6 +1771,16 @@ assert.deepStrictEqual(modifyAt(1, double)([]), none)
 
 Added in v2.0.0
 
+## sequence
+
+**Signature**
+
+```ts
+export declare const sequence: Sequence1<'Array'>
+```
+
+Added in v2.6.3
+
 ## splitAt
 
 Splits an array into two pieces, the first piece has `n` elements.
@@ -1791,6 +1804,26 @@ assert.deepStrictEqual(splitAt(2)([1, 2, 3, 4, 5]), [
 
 Added in v2.0.0
 
+## traverse
+
+**Signature**
+
+```ts
+export declare const traverse: PipeableTraverse1<'Array'>
+```
+
+Added in v2.6.3
+
+## traverseWithIndex
+
+**Signature**
+
+```ts
+export declare const traverseWithIndex: PipeableTraverseWithIndex1<'Array', number>
+```
+
+Added in v2.6.3
+
 ## unzip
 
 The function is reverse of `zip`. Takes an array of pairs and return two corresponding arrays

docs/modules/Either.ts.md

@@ -83,7 +83,9 @@ Added in v2.0.0
 - [utils](#utils)
   - [elem](#elem)
   - [exists](#exists)
+  - [sequence](#sequence)
   - [toError](#toerror)
+  - [traverse](#traverse)
 
 ---
 
@@ -783,6 +785,16 @@ assert.strictEqual(gt2(right(3)), true)
 
 Added in v2.0.0
 
+## sequence
+
+**Signature**
+
+```ts
+export declare const sequence: Sequence2<'Either'>
+```
+
+Added in v2.6.3
+
 ## toError
 
 Default value for the `onError` argument of `tryCatch`
@@ -794,3 +806,13 @@ export declare function toError(e: unknown): Error
 ```
 
 Added in v2.0.0
+
+## traverse
+
+**Signature**
+
+```ts
+export declare const traverse: PipeableTraverse2<'Either'>
+```
+
+Added in v2.6.3

docs/modules/IOEither.ts.md

@@ -28,12 +28,16 @@ Added in v2.0.0
   - [map](#map)
 - [Monad](#monad)
   - [chain](#chain)
-  - [chainEitherK](#chaineitherk)
   - [chainFirst](#chainfirst)
   - [chainW](#chainw)
   - [flatten](#flatten)
+- [MonadThrow](#monadthrow)
+  - [bracket](#bracket)
 - [combinators](#combinators)
+  - [chainEitherK](#chaineitherk)
+  - [chainEitherKW](#chaineitherkw)
   - [filterOrElse](#filterorelse)
+  - [fromEitherK](#fromeitherk)
   - [orElse](#orelse)
   - [swap](#swap)
 - [constructors](#constructors)
@@ -60,10 +64,6 @@ Added in v2.0.0
   - [IOEither (interface)](#ioeither-interface)
   - [URI](#uri)
   - [URI (type alias)](#uri-type-alias)
-- [utils](#utils)
-  - [bracket](#bracket)
-  - [chainEitherKW](#chaineitherkw)
-  - [fromEitherK](#fromeitherk)
 
 ---
 
@@ -157,16 +157,6 @@ export declare const chain: <E, A, B>(f: (a: A) => IOEither<E, B>) => (ma: IOEit
 
 Added in v2.0.0
 
-## chainEitherK
-
-**Signature**
-
-```ts
-export declare function chainEitherK<E, A, B>(f: (a: A) => Either<E, B>): (ma: IOEither<E, A>) => IOEither<E, B>
-```
-
-Added in v2.4.0
-
 ## chainFirst
 
 **Signature**
@@ -197,8 +187,51 @@ export declare const flatten: <E, A>(mma: IOEither<E, IOEither<E, A>>) => IOEith
 
 Added in v2.0.0
 
+# MonadThrow
+
+## bracket
+
+Make sure that a resource is cleaned up in the event of an exception (_). The release action is called regardless of
+whether the body action throws (_) or returns.
+
+(\*) i.e. returns a `Left`
+
+**Signature**
+
+```ts
+export declare const bracket: <E, A, B>(
+  acquire: IOEither<E, A>,
+  use: (a: A) => IOEither<E, B>,
+  release: (a: A, e: E.Either<E, B>) => IOEither<E, void>
+) => IOEither<E, B>
+```
+
+Added in v2.0.0
+
 # combinators
 
+## chainEitherK
+
+**Signature**
+
+```ts
+export declare function chainEitherK<E, A, B>(f: (a: A) => Either<E, B>): (ma: IOEither<E, A>) => IOEither<E, B>
+```
+
+Added in v2.4.0
+
+## chainEitherKW
+
+**Signature**
+
+```ts
+export declare const chainEitherKW: <D, A, B>(
+  f: (a: A) => E.Either<D, B>
+) => <E>(ma: IOEither<E, A>) => IOEither<D | E, B>
+```
+
+Added in v2.6.1
+
 ## filterOrElse
 
 **Signature**
@@ -212,12 +245,24 @@ export declare const filterOrElse: {
 
 Added in v2.0.0
 
+## fromEitherK
+
+**Signature**
+
+```ts
+export declare function fromEitherK<E, A extends ReadonlyArray<unknown>, B>(
+  f: (...a: A) => Either<E, B>
+): (...a: A) => IOEither<E, B>
+```
+
+Added in v2.4.0
+
 ## orElse
 
 **Signature**
 
 ```ts
-export declare function orElse<E, A, M>(onLeft: (e: E) => IOEither<M, A>): (ma: IOEither<E, A>) => IOEither<M, A>
+export declare const orElse: <E, A, M>(onLeft: (e: E) => IOEither<M, A>) => (ma: IOEither<E, A>) => IOEither<M, A>
 ```
 
 Added in v2.0.0
@@ -282,7 +327,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare const leftIO: <E = never, A = never>(me: IO<E>) => IOEither<E, A>
+export declare const leftIO: <E = never, A = never>(me: I.IO<E>) => IOEither<E, A>
 ```
 
 Added in v2.0.0
@@ -302,7 +347,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare const rightIO: <E = never, A = never>(ma: IO<A>) => IOEither<E, A>
+export declare const rightIO: <E = never, A = never>(ma: I.IO<A>) => IOEither<E, A>
 ```
 
 Added in v2.0.0
@@ -326,7 +371,10 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare function fold<E, A, B>(onLeft: (e: E) => IO<B>, onRight: (a: A) => IO<B>): (ma: IOEither<E, A>) => IO<B>
+export declare const fold: <E, A, B>(
+  onLeft: (e: E) => I.IO<B>,
+  onRight: (a: A) => I.IO<B>
+) => (ma: IOEither<E, A>) => I.IO<B>
 ```
 
 Added in v2.0.0
@@ -336,7 +384,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare function getOrElse<E, A>(onLeft: (e: E) => IO<A>): (ma: IOEither<E, A>) => IO<A>
+export declare const getOrElse: <E, A>(onLeft: (e: E) => I.IO<A>) => (ma: IOEither<E, A>) => I.IO<A>
 ```
 
 Added in v2.0.0
@@ -346,7 +394,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare const getOrElseW: <E, B>(onLeft: (e: E) => IO<B>) => <A>(ma: IOEither<E, A>) => IO<B | A>
+export declare const getOrElseW: <E, B>(onLeft: (e: E) => I.IO<B>) => <A>(ma: IOEither<E, A>) => I.IO<B | A>
 ```
 
 Added in v2.6.0
@@ -456,48 +504,3 @@ export type URI = typeof URI
 ```
 
 Added in v2.0.0
-
-# utils
-
-## bracket
-
-Make sure that a resource is cleaned up in the event of an exception (_). The release action is called regardless of
-whether the body action throws (_) or returns.
-
-(\*) i.e. returns a `Left`
-
-**Signature**
-
-```ts
-export declare function bracket<E, A, B>(
-  acquire: IOEither<E, A>,
-  use: (a: A) => IOEither<E, B>,
-  release: (a: A, e: Either<E, B>) => IOEither<E, void>
-): IOEither<E, B>
-```
-
-Added in v2.0.0
-
-## chainEitherKW
-
-**Signature**
-
-```ts
-export declare const chainEitherKW: <D, A, B>(
-  f: (a: A) => E.Either<D, B>
-) => <E>(ma: IOEither<E, A>) => IOEither<D | E, B>
-```
-
-Added in v2.6.1
-
-## fromEitherK
-
-**Signature**
-
-```ts
-export declare function fromEitherK<E, A extends ReadonlyArray<unknown>, B>(
-  f: (...a: A) => Either<E, B>
-): (...a: A) => IOEither<E, B>
-```
-
-Added in v2.4.0

docs/modules/Identity.ts.md

@@ -41,6 +41,9 @@ Added in v2.0.0
   - [Identity (type alias)](#identity-type-alias)
   - [URI](#uri)
   - [URI (type alias)](#uri-type-alias)
+- [utils](#utils)
+  - [sequence](#sequence)
+  - [traverse](#traverse)
 
 ---
 
@@ -266,3 +269,25 @@ export type URI = typeof URI
 ```
 
 Added in v2.0.0
+
+# utils
+
+## sequence
+
+**Signature**
+
+```ts
+export declare const sequence: Sequence1<'Identity'>
+```
+
+Added in v2.6.3
+
+## traverse
+
+**Signature**
+
+```ts
+export declare const traverse: PipeableTraverse1<'Identity'>
+```
+
+Added in v2.6.3