Skip to content

Commit cd60945

Browse files
committed
Update docs
1 parent d9fa24f commit cd60945

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,35 @@
115115

116116
## Module Node.FS.Sync
117117

118+
### Types
119+
120+
type BufferLength = Number
121+
122+
type BufferOffset = Number
123+
124+
type ByteCount = Number
125+
126+
data FileDescriptor :: *
127+
128+
data FileFlags where
129+
R :: FileFlags
130+
R_PLUS :: FileFlags
131+
RS :: FileFlags
132+
RS_PLUS :: FileFlags
133+
W :: FileFlags
134+
WX :: FileFlags
135+
W_PLUS :: FileFlags
136+
WX_PLUS :: FileFlags
137+
A :: FileFlags
138+
AX :: FileFlags
139+
A_PLUS :: FileFlags
140+
AX_PLUS :: FileFlags
141+
142+
type FileMode = Number
143+
144+
type FilePosition = Number
145+
146+
118147
### Values
119148

120149
appendFile :: forall eff. FilePath -> Buffer -> Eff (err :: Exception, fs :: FS | eff) Unit
@@ -127,6 +156,20 @@
127156

128157
exists :: forall eff. FilePath -> Eff (fs :: FS | eff) Boolean
129158

159+
fdAppend :: forall eff. FileDescriptor -> Buffer -> Eff (fs :: FS, err :: Exception | eff) ByteCount
160+
161+
fdClose :: forall eff. FileDescriptor -> Eff (fs :: FS, err :: Exception | eff) Unit
162+
163+
fdFlush :: forall eff. FileDescriptor -> Eff (fs :: FS, err :: Exception | eff) Unit
164+
165+
fdNext :: forall eff. FileDescriptor -> Buffer -> Eff (fs :: FS, err :: Exception | eff) ByteCount
166+
167+
fdOpen :: forall opts eff. FilePath -> FileFlags -> Maybe FileMode -> Eff (fs :: FS, err :: Exception | eff) FileDescriptor
168+
169+
fdRead :: forall eff. FileDescriptor -> Buffer -> BufferOffset -> BufferLength -> Maybe FilePosition -> Eff (fs :: FS, err :: Exception | eff) ByteCount
170+
171+
fdWrite :: forall eff. FileDescriptor -> Buffer -> BufferOffset -> BufferLength -> Maybe FilePosition -> Eff (fs :: FS, err :: Exception | eff) ByteCount
172+
130173
link :: forall eff. FilePath -> FilePath -> Eff (err :: Exception, fs :: FS | eff) Unit
131174

132175
mkdir :: forall eff. FilePath -> Eff (err :: Exception, fs :: FS | eff) Unit

0 commit comments

Comments
 (0)