Commit 9eab6bc

authored

Update documentation reflecting removal of async exists (#433)

* Update documentation reflecting removal of async exists * Add node-fs-aff breaking changes.

1 parent 314ec38 commit 9eab6bcCopy full SHA for 9eab6bc

File tree

+18

-1

lines changed

+18

-1

lines changed

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -398,10 +398,13 @@ Breaking changes:`
`398`	`398`
`399`	`399`	`Breaking changes:`
`400`	`400`	- Update `mkdir'` to take options arg ([#34](https://github.com/node/purescript-node-fs-aff/pull/34) by @JordanMartinez)
	`401`	+- 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.
`401`	`402`
`402`	`403`	`### purescript-node-fs`
`403`	`404`
`404`	`405`	`Breaking changes:`
	`406`	+- Remove deprecated `Async.exists` ([#61](https://github.com/purescript-node/purescript-node-fs/pull/61) by @sigma-andex). Use `Sync.exists` instead.
	`407`	`+`
`405`	`408`	- 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)
`406`	`409`
`407`	`410`	To get back the old behavior of `mkdir'`, you would call `mkdir' { recursive: false, mode: mkPerms all all all }`

Lines changed: 15 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -665,6 +665,20 @@ Previously, `mkdir` did not expose all the fields in the options arg. So, trying
`665`	`665`	- update `mkdir' path perms` to `mkdir' path { recursive: false, mode: perms }`
`666`	`666`	- to get just the recursive behavior, use `mkdir' path { recursive: true, mode: mkPerms all all all }`
`667`	`667`
	`668`	+### Remove `Async.exists` (`purescript-node-fs`)
	`669`	`+`
	`670`	+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.
	`671`	`+`
	`672`	`+To fix:`
	`673`	+- use `exists` from the `Sync` module
	`674`	`+`
	`675`	+### Remove `exists` (`purescript-node-fs-aff`)
	`676`	`+`
	`677`	+`exists` has been removed since the underlying `Async.exists` from `purescript-node-fs` has been removed.
	`678`	`+`
	`679`	`+To fix:`
	`680`	+- import the `node-fs` package's `Node.Fs.Sync (exists)` function and wrap in `liftEffect` (e.g. `liftEffect $ Sync.exists path`)
	`681`	`+`
`668`	`682`	## Breaking Changes in the `purescript-web` libraries
`669`	`683`
`670`	`684`	### `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`
`757`	`771`
`758`	`772`	`- type FooT = FT a`
`759`	`773`	`+ type FooT = ExceptT (NonEmptyList ForeignError) m a`
`760`		-```
	`774`	+```

Comments

(0)