Update documentation reflecting removal of async exists (#433)

sigma-andex · web-flow · commit 9eab6bced78c · 2022-04-14T11:27:10.000-05:00
* Update documentation reflecting removal of async exists

* Add node-fs-aff breaking changes.
diff --git a/migration-guides/0.15-Ecosystem-Update.md b/migration-guides/0.15-Ecosystem-Update.md
@@ -398,10 +398,13 @@ Breaking changes:
 
 Breaking changes:
 - Update `mkdir'` to take options arg ([#34](https://github.com/node/purescript-node-fs-aff/pull/34) by @JordanMartinez)
+- Remove `exists` since underlying `Async.exists` from `purescript-node-fs` was removed ([#61](https://github.com/purescript-node/purescript-node-fs-aff/pull/36) by @sigma-andex). Use `Sync.exists` instead.
 
 ### purescript-node-fs
 
 Breaking changes:
+- Remove deprecated `Async.exists` ([#61](https://github.com/purescript-node/purescript-node-fs/pull/61) by @sigma-andex). Use `Sync.exists` instead.
+
 - Update `mkdir` to take an options record arg, exposing `recursive` option ([#53](https://github.com/node/purescript-node-fs/pull/53), #55, #58 by @JordanMartinez)
 
   To get back the old behavior of `mkdir'`, you would call `mkdir' { recursive: false, mode: mkPerms all all all }`
diff --git a/migration-guides/0.15-Migration-Guide.md b/migration-guides/0.15-Migration-Guide.md
@@ -665,6 +665,20 @@ Previously, `mkdir` did not expose all the fields in the options arg. So, trying
 - update `mkdir' path perms` to `mkdir' path { recursive: false, mode: perms }`
 - to get just the recursive behavior, use `mkdir' path { recursive: true, mode: mkPerms all all all }`
 
+### Remove `Async.exists` (`purescript-node-fs`)
+
+The async `exists` version from `purescript-node-fs` has been removed since the underlying Node.js version has been deprecated since Node.js version 1.
+
+**To fix**:
+- use `exists` from the `Sync` module
+
+### Remove `exists` (`purescript-node-fs-aff`)
+
+`exists` has been removed since the underlying `Async.exists` from `purescript-node-fs` has been removed.
+
+**To fix**:
+- import the `node-fs` package's `Node.Fs.Sync (exists)` function and wrap in `liftEffect` (e.g. `liftEffect $ Sync.exists path`)
+
 ## Breaking Changes in the `purescript-web` libraries
 
 ### `Arc` record type includes field for representing arc direction (`purescript-canvas`)
@@ -757,4 +771,4 @@ While this doesn't count as a breaking change, nor are we deprecating those type
 
 - type FooT = FT a
 + type FooT = ExceptT (NonEmptyList ForeignError) m a
-```
+```
