add pipeable top level wither / wilt

gcanti · Jun 10, 2020 · dbf6cf9 · dbf6cf9
1 parent 0c2b9a1
commit dbf6cf9
Show file tree

Hide file tree

Showing 17 changed files with 761 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,12 @@
 **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.5
+
+- **Polish**
+  - export a pipeable `wither` function from all modules which admit a `Witherable` instance (@gcanti)
+  - export a pipeable `wilt` function from all modules which admit a `Witherable` instance (@gcanti)
+
 # 2.6.4
 
 - **Bug Fix**

diff --git a/docs/modules/Array.ts.md b/docs/modules/Array.ts.md
@@ -50,6 +50,9 @@ Added in v2.0.0
   - [chain](#chain)
   - [chainFirst](#chainfirst)
   - [flatten](#flatten)
+- [Whitherable](#whitherable)
+  - [wilt](#wilt)
+  - [wither](#wither)
 - [combinators](#combinators)
   - [chop](#chop)
   - [copy](#copy)
@@ -461,6 +464,28 @@ assert.deepStrictEqual(flatten([[1], [2], [3]]), [1, 2, 3])
 
 Added in v2.0.0
 
+# Whitherable
+
+## wilt
+
+**Signature**
+
+```ts
+export declare const wilt: PipeableWilt1<'Array'>
+```
+
+Added in v2.6.5
+
+## wither
+
+**Signature**
+
+```ts
+export declare const wither: PipeableWither1<'Array'>
+```
+
+Added in v2.6.5
+
 # combinators
 
 ## chop

diff --git a/docs/modules/Option.ts.md b/docs/modules/Option.ts.md
@@ -53,6 +53,9 @@ Added in v2.0.0
 - [Traversable](#traversable)
   - [sequence](#sequence)
   - [traverse](#traverse)
+- [Whitherable](#whitherable)
+  - [wilt](#wilt)
+  - [wither](#wither)
 - [combinators](#combinators)
   - [mapNullable](#mapnullable)
 - [constructors](#constructors)
@@ -370,6 +373,28 @@ export declare const traverse: PipeableTraverse1<'Option'>
 
 Added in v2.6.3
 
+# Whitherable
+
+## wilt
+
+**Signature**
+
+```ts
+export declare const wilt: PipeableWilt1<'Option'>
+```
+
+Added in v2.6.5
+
+## wither
+
+**Signature**
+
+```ts
+export declare const wither: PipeableWither1<'Option'>
+```
+
+Added in v2.6.5
+
 # combinators
 
 ## mapNullable

diff --git a/docs/modules/ReadonlyArray.ts.md b/docs/modules/ReadonlyArray.ts.md
@@ -50,6 +50,9 @@ Added in v2.5.0
   - [chain](#chain)
   - [chainFirst](#chainfirst)
   - [flatten](#flatten)
+- [Whitherable](#whitherable)
+  - [wilt](#wilt)
+  - [wither](#wither)
 - [combinators](#combinators)
   - [chop](#chop)
   - [difference](#difference)
@@ -467,6 +470,28 @@ assert.deepStrictEqual(flatten([[1], [2], [3]]), [1, 2, 3])
 
 Added in v2.5.0
 
+# Whitherable
+
+## wilt
+
+**Signature**
+
+```ts
+export declare const wilt: PipeableWilt1<'ReadonlyArray'>
+```
+
+Added in v2.6.5
+
+## wither
+
+**Signature**
+
+```ts
+export declare const wither: PipeableWither1<'ReadonlyArray'>
+```
+
+Added in v2.6.5
+
 # combinators
 
 ## chop

diff --git a/docs/modules/ReadonlyRecord.ts.md b/docs/modules/ReadonlyRecord.ts.md
@@ -24,6 +24,9 @@ Added in v2.5.0
   - [foldMap](#foldmap)
   - [reduce](#reduce)
   - [reduceRight](#reduceright)
+- [Whitherable](#whitherable)
+  - [wilt](#wilt)
+  - [wither](#wither)
 - [combinators](#combinators)
   - [deleteAt](#deleteat)
   - [filterMapWithIndex](#filtermapwithindex)
@@ -187,6 +190,28 @@ export declare const reduceRight: <A, B>(b: B, f: (a: A, b: B) => B) => (fa: Rea
 
 Added in v2.5.0
 
+# Whitherable
+
+## wilt
+
+**Signature**
+
+```ts
+export declare const wilt: PipeableWilt1<'ReadonlyRecord'>
+```
+
+Added in v2.6.5
+
+## wither
+
+**Signature**
+
+```ts
+export declare const wither: PipeableWither1<'ReadonlyRecord'>
+```
+
+Added in v2.6.5
+
 # combinators
 
 ## deleteAt

diff --git a/docs/modules/Record.ts.md b/docs/modules/Record.ts.md
@@ -24,6 +24,9 @@ Added in v2.0.0
   - [foldMap](#foldmap)
   - [reduce](#reduce)
   - [reduceRight](#reduceright)
+- [Whitherable](#whitherable)
+  - [wilt](#wilt)
+  - [wither](#wither)
 - [model](#model)
   - [URI](#uri)
   - [URI (type alias)](#uri-type-alias)
@@ -176,6 +179,28 @@ export declare const reduceRight: <A, B>(b: B, f: (a: A, b: B) => B) => (fa: Rec
 
 Added in v2.0.0
 
+# Whitherable
+
+## wilt
+
+**Signature**
+
+```ts
+export declare const wilt: PipeableWilt1<'Record'>
+```
+
+Added in v2.6.5
+
+## wither
+
+**Signature**
+
+```ts
+export declare const wither: PipeableWither1<'Record'>
+```
+
+Added in v2.6.5
+
 # model
 
 ## URI