Skip to content

Commit 6308177

Browse files
committed
Add generated docs
1 parent ee8e3b0 commit 6308177

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
purescript-readline
2-
===================
1+
# Module Documentation
2+
3+
## Module Node.ReadLine
4+
5+
### Types
6+
7+
type Completer eff = String -> Eff eff (Tuple [String] String)
8+
9+
data Console :: !
10+
11+
data InputStream :: *
12+
13+
data Interface :: *
14+
15+
type LineHandler eff = String -> Eff eff { }
16+
17+
data OutputStream :: *
18+
19+
20+
### Values
21+
22+
createInterface :: forall eff. InputStream -> OutputStream -> Completer eff -> Eff (console :: Console | eff) Interface
23+
24+
process :: { stdin :: InputStream, stdout :: OutputStream, stderr :: OutputStream }
25+
26+
prompt :: forall eff. Interface -> Eff (console :: Console | eff) Interface
27+
28+
setLineHandler :: forall eff. LineHandler eff -> Interface -> Eff (console :: Console | eff) Interface
29+
30+
setPrompt :: forall eff. String -> Number -> Interface -> Eff (console :: Console | eff) Interface

0 commit comments

Comments
 (0)