Option: remove compact

fp-ts · Feb 7, 2023 · bfb2249 · bfb2249
1 parent a4a6ebb
commit bfb2249
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 16 deletions.
diff --git a/.changeset/tender-bugs-shave.md b/.changeset/tender-bugs-shave.md
@@ -0,0 +1,5 @@
+---
+"@fp-ts/core": patch
+---
+
+Option: remove `compact`
diff --git a/src/Option.ts b/src/Option.ts
@@ -727,20 +727,12 @@ export const Foldable: foldable.Foldable<OptionTypeLambda> = {
  */
 export const toArray: <A>(self: Option<A>) => Array<A> = foldable.toArray(Foldable)
 
-/**
- * Alias of `flatten`.
- *
- * @category filtering
- * @since 1.0.0
- */
-export const compact: <A>(self: Option<Option<A>>) => Option<A> = flatten
-
 /**
  * @category instances
  * @since 1.0.0
  */
 export const Compactable: compactable.Compactable<OptionTypeLambda> = {
-  compact
+  compact: flatten
 }
 
 /**

diff --git a/test/Option.ts b/test/Option.ts
@@ -76,7 +76,6 @@ describe.concurrent("Option", () => {
     expect(_.traverseTap).exist
 
     expect(_.Compactable).exist
-    expect(_.compact).exist
     expect(_.separate).exist
 
     expect(_.Filterable).exist
@@ -288,12 +287,6 @@ describe.concurrent("Option", () => {
     assertAlt(_.none(), _.none(), _.none())
   })
 
-  it("compact", () => {
-    Util.deepStrictEqual(_.compact(_.none()), _.none())
-    Util.deepStrictEqual(_.compact(_.some(_.none())), _.none())
-    Util.deepStrictEqual(_.compact(_.some(_.some("123"))), _.some("123"))
-  })
-
   it("filterMap", () => {
     const f = (n: number) => (p(n) ? _.some(n + 1) : _.none())
     Util.deepStrictEqual(pipe(_.none(), _.filterMap(f)), _.none())