Skip to content
This repository was archived by the owner on Aug 4, 2023. It is now read-only.

Commit eabddfb

Browse files
Deprecate repo (#41)
* Replace readme with deprecation notice * Add pursuit keyword
1 parent 5ed121e commit eabddfb

File tree

2 files changed

+5
-37
lines changed

2 files changed

+5
-37
lines changed

README.md

+3-36
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,6 @@
1-
# purescript-node-fs-aff
1+
# DEPRECATED
22

3-
[![Latest release](http://img.shields.io/github/release/purescript-node/purescript-node-fs-aff.svg)](https://github.com/purescript-node/purescript-node-fs-aff/releases)
4-
[![Build status](https://github.com/purescript-node/purescript-node-fs-aff/workflows/CI/badge.svg?branch=master)](https://github.com/purescript-node/purescript-node-fs-aff/actions?query=workflow%3ACI+branch%3Amaster)
5-
[![Pursuit](https://pursuit.purescript.org/packages/purescript-node-fs-aff/badge)](https://pursuit.purescript.org/packages/purescript-node-fs-aff)
3+
`purescript-node-fs-aff` is deprecated. Functions and values from this library were merged as-is into the [`purescript-node-fs`](https://github.com/purescript/purescript-node-fs) library.
64

7-
[Node.FS][node.fs] wrappers for [purescript-aff][aff].
5+
The [original releases up to v9.2.0](https://github.com/purescript-deprecated/purescript-node-fs-aff/releases) of this library are still available and will work with compiler versions prior to PureScript v0.16.x.
86

9-
The `Aff` monad lets you write async code with ease, and `node-fs-aff` lets you easily access the filesystem within `Aff`.
10-
11-
## Installation
12-
13-
```
14-
spago install node-fs-aff
15-
```
16-
17-
## Example
18-
19-
Consider asynchronously listing only non-hidden directories:
20-
21-
```purescript
22-
main = launchAff do
23-
files <- FS.readdir "."
24-
files' <- flip filterM files \file -> do
25-
stat <- FS.stat file
26-
pure $
27-
FS.isDirectory stat
28-
&& (maybe false (fromChar >>> (/= ".")) $ charAt 0 file)
29-
liftEff $ print files'
30-
```
31-
32-
That was easy. Run `npm run example` to see it work.
33-
34-
## Documentation
35-
36-
Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-node-fs-aff).
37-
38-
[node.fs]: http://github.com/purescript-node/purescript-node-fs
39-
[aff]: https://github.com/slamdata/purescript-aff

bower.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
"description": "Aff wrappers for purescript-node-fs",
1111
"keywords": [
1212
"purescript",
13-
"node"
13+
"node",
14+
"pursuit-deprecated"
1415
],
1516
"license": "MIT",
1617
"homepage": "https://github.com/purescript-node/purescript-node-fs-aff",

0 commit comments

Comments
 (0)