Skip to content

Commit d0b3845

Browse files
committed
Update docs
1 parent 1658abe commit d0b3845

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,24 @@ exists :: forall eff. FilePath -> (Boolean -> Eff eff Unit) -> Eff (fs :: FS | e
181181

182182
## Module Node.FS.Perms
183183

184+
#### `Perm`
185+
186+
``` purescript
187+
newtype Perm
188+
```
189+
190+
184191
#### `Perms`
185192

186193
``` purescript
187-
data Perms
194+
newtype Perms
195+
```
196+
197+
198+
#### `semigroupPerm`
199+
200+
``` purescript
201+
instance semigroupPerm :: Semigroup Perm
188202
```
189203

190204

@@ -195,17 +209,24 @@ permsFromString :: String -> Maybe Perms
195209
```
196210

197211

212+
#### `mkPerms`
213+
214+
``` purescript
215+
mkPerms :: Perm -> Perm -> Perm -> Perms
216+
```
217+
218+
198219
#### `permsToString`
199220

200221
``` purescript
201222
permsToString :: Perms -> String
202223
```
203224

204225

205-
#### `permsToNum`
226+
#### `permsToInt`
206227

207228
``` purescript
208-
permsToNum :: Perms -> Number
229+
permsToInt :: Perms -> Int
209230
```
210231

211232

@@ -559,4 +580,4 @@ fdFlush :: forall eff. FileDescriptor -> Eff (fs :: FS, err :: Exception | eff)
559580

560581
``` purescript
561582
fdClose :: forall eff. FileDescriptor -> Eff (fs :: FS, err :: Exception | eff) Unit
562-
```
583+
```

0 commit comments

Comments
 (0)