git.iko.soy/rowtype-yoga/purescript-native
on golang help sign in
Fix docgen, update Prelude docs
5337859Phil Freeman
prelude/README.md+209
compare with golang
unifiedsplit
@@ -3,43 +3,220 @@
3
3
4### Types
4### Types
5
5
6+ data Ordering where
7+ LT :: Ordering
8+ GT :: Ordering
9+ EQ :: Ordering
10+
6
11
7### Type Classes
12### Type Classes
8
13
14+ class Alternative f where
15+ empty :: forall a. f a
16+ (<|>) :: forall a. f a -> f a -> f a
17+
18+ class Applicative f where
19+ pure :: forall a. a -> f a
20+ (<*>) :: forall a b. f (a -> b) -> f a -> f b
21+
22+ class Bits b where
23+ (&) :: b -> b -> b
24+ (|) :: b -> b -> b
25+ (^) :: b -> b -> b
26+ shl :: b -> Prim.Number -> b
27+ shr :: b -> Prim.Number -> b
28+ zshr :: b -> Prim.Number -> b
29+ complement :: b -> b
30+
31+ class BoolLike b where
32+ (&&) :: b -> b -> b
33+ (||) :: b -> b -> b
34+ not :: b -> b
35+
36+ class Category a where
37+ id :: forall t. a t t
38+ (<<<) :: forall b c d. a c d -> a b c -> a b d
39+
40+ class Eq a where
41+ (==) :: a -> a -> Prim.Boolean
42+ (/=) :: a -> a -> Prim.Boolean
43+
44+ class Functor f where
45+ (<$>) :: forall a b. (a -> b) -> f a -> f b
46+
47+ class Monad m where
48+ return :: forall a. a -> m a
49+ (>>=) :: forall a b. m a -> (a -> m b) -> m b
50+
51+ class Num a where
52+ (+) :: a -> a -> a
53+ (-) :: a -> a -> a
54+ (*) :: a -> a -> a
55+ (/) :: a -> a -> a
56+ (%) :: a -> a -> a
57+ negate :: a -> a
58+
59+ class Ord a where
60+ compare :: a -> a -> Ordering
61+
62+ class Show a where
63+ show :: a -> Prim.String
64+
9
65
10### Type Class Instances
66### Type Class Instances
11
67
68+ instance applicativeFromMonad :: (Monad m) => Applicative m
69+
70+ instance bitsNumber :: Bits Prim.Number
71+
72+ instance boolLikeBoolean :: BoolLike Prim.Boolean
73+
74+ instance categoryArr :: Category Prim.Function
75+
76+ instance eqArray :: (Eq a) => Eq [a]
77+
78+ instance eqBoolean :: Eq Prim.Boolean
79+
80+ instance eqNumber :: Eq Prim.Number
81+
82+ instance eqString :: Eq Prim.String
83+
84+ instance functorFromApplicative :: (Applicative f) => Functor f
85+
86+ instance numNumber :: Num Prim.Number
87+
88+ instance ordNumber :: Ord Prim.Number
89+
90+ instance showBoolean :: Show Prim.Boolean
91+
92+ instance showNumber :: Show Prim.Number
93+
94+ instance showOrdering :: Show Ordering
95+
96+ instance showString :: Show Prim.String
97+
12
98
13### Values
99### Values
14
100
101+ (!!) :: forall a. [a] -> Prim.Number -> a
102+
103+ (#) :: forall a b. a -> (a -> b) -> b
104+
105+ ($) :: forall a b. (a -> b) -> a -> b
106+
107+ (++) :: Prim.String -> Prim.String -> Prim.String
108+
109+ (<) :: forall a. (Ord a) => a -> a -> Prim.Boolean
110+
111+ (<=) :: forall a. (Ord a) => a -> a -> Prim.Boolean
112+
113+ (>) :: forall a. (Ord a) => a -> a -> Prim.Boolean
114+
115+ (>=) :: forall a. (Ord a) => a -> a -> Prim.Boolean
116+
117+ (>>>) :: forall a b c d. (Category a) => a b c -> a c d -> a b d
118+
119+ boolAnd :: Prim.Boolean -> Prim.Boolean -> Prim.Boolean
120+
121+ boolNot :: Prim.Boolean -> Prim.Boolean
122+
123+ boolOr :: Prim.Boolean -> Prim.Boolean -> Prim.Boolean
124+
125+ const :: forall a b. a -> b -> a
126+
127+ flip :: forall a b c. (a -> b -> c) -> b -> a -> c
128+
129+ numAdd :: Prim.Number -> Prim.Number -> Prim.Number
130+
131+ numAnd :: Prim.Number -> Prim.Number -> Prim.Number
132+
133+ numCompare :: Prim.Number -> Prim.Number -> Ordering
134+
135+ numComplement :: Prim.Number -> Prim.Number
136+
137+ numDiv :: Prim.Number -> Prim.Number -> Prim.Number
138+
139+ numMod :: Prim.Number -> Prim.Number -> Prim.Number
140+
141+ numMul :: Prim.Number -> Prim.Number -> Prim.Number
142+
143+ numNegate :: Prim.Number -> Prim.Number
144+
145+ numOr :: Prim.Number -> Prim.Number -> Prim.Number
146+
147+ numShl :: Prim.Number -> Prim.Number -> Prim.Number
148+
149+ numShr :: Prim.Number -> Prim.Number -> Prim.Number
150+
151+ numSub :: Prim.Number -> Prim.Number -> Prim.Number
152+
153+ numXor :: Prim.Number -> Prim.Number -> Prim.Number
154+
155+ numZshr :: Prim.Number -> Prim.Number -> Prim.Number
156+
157+ on :: forall a b c. (b -> b -> c) -> (a -> b) -> a -> a -> c
158+
159+ refEq :: forall a. a -> a -> Prim.Boolean
160+
161+ refIneq :: forall a. a -> a -> Prim.Boolean
162+
163+ showNumberImpl :: Prim.Number -> Prim.String
164+
15
165
16## Module Data.Eq
166## Module Data.Eq
17
167
18### Types
168### Types
19
169
170+ data Ref a where
171+ Ref :: a -> Ref a
172+
20
173
21### Type Classes
174### Type Classes
22
175
23
176
24### Type Class Instances
177### Type Class Instances
25
178
179+ instance eqRef :: Eq (Ref a)
180+
26
181
27### Values
182### Values
28
183
184+ liftRef :: forall a b. (a -> a -> b) -> Ref a -> Ref a -> b
185+
29
186
30## Module Control.Monad.Eff
187## Module Control.Monad.Eff
31
188
32### Types
189### Types
33
190
191+ data Eff :: # ! -> * -> *
192+
193+ type Pure a = forall e. Eff e a
194+
34
195
35### Type Classes
196### Type Classes
36
197
37
198
38### Type Class Instances
199### Type Class Instances
39
200
201+ instance monadEff :: Monad (Eff e)
202+
40
203
41### Values
204### Values
42
205
206+ bindEff :: forall e a b. Eff e a -> (a -> Eff e b) -> Eff e b
207+
208+ forE :: forall e. Prim.Number -> Prim.Number -> (Prim.Number -> Eff e { }) -> Eff e { }
209+
210+ foreachE :: forall e a. [a] -> (a -> Eff e { }) -> Eff e { }
211+
212+ retEff :: forall e a. a -> Eff e a
213+
214+ runPure :: forall a. Pure a -> a
215+
216+ untilE :: forall e. Eff e Prim.Boolean -> Eff e { }
217+
218+ whileE :: forall e a. Eff e Prim.Boolean -> Eff e a -> Eff e { }
219+
43
220
44## Module Control.Monad.Eff.Unsafe
221## Module Control.Monad.Eff.Unsafe
45
222
@@ -54,11 +231,15 @@
54
231
55### Values
232### Values
56
233
234+ unsafeInterleaveEff :: forall eff1 eff2 a. Eff eff1 a -> Eff eff2 a
235+
57
236
58## Module Debug.Trace
237## Module Debug.Trace
59
238
60### Types
239### Types
61
240
241+ data Trace :: !
242+
62
243
63### Type Classes
244### Type Classes
64
245
@@ -68,11 +249,21 @@
68
249
69### Values
250### Values
70
251
252+ print :: forall a r. (Show a) => a -> Eff (trace :: Trace | r) { }
253+
254+ trace :: forall r. Prim.String -> Eff (trace :: Trace | r) { }
255+
71
256
72## Module Control.Monad.ST
257## Module Control.Monad.ST
73
258
74### Types
259### Types
75
260
261+ data ST :: * -> !
262+
263+ data STArray :: * -> * -> *
264+
265+ data STRef :: * -> * -> *
266+
76
267
77### Type Classes
268### Type Classes
78
269
@@ -82,5 +273,23 @@
82
273
83### Values
274### Values
84
275
276+ modifySTRef :: forall a h r. STRef h a -> (a -> a) -> Eff (st :: ST h | r) a
277+
278+ newSTArray :: forall a h r. Prim.Number -> a -> Eff (st :: ST h | r) (STArray h a)
279+
280+ newSTRef :: forall a h r. a -> Eff (st :: ST h | r) (STRef h a)
281+
282+ peekSTArray :: forall a h r. STArray h a -> Eff (st :: ST h | r) a
283+
284+ pokeSTArray :: forall a h r. STArray h a -> Prim.Number -> a -> Eff (st :: ST h | r) a
285+
286+ readSTRef :: forall a h r. STRef h a -> Eff (st :: ST h | r) a
287+
288+ runST :: forall a r. (forall h. Eff (st :: ST h | r) a) -> Eff r a
289+
290+ runSTArray :: forall a r. (forall h. Eff (st :: ST h | r) (STArray h a)) -> Eff r [a]
291+
292+ writeSTRef :: forall a h r. STRef h a -> a -> Eff (st :: ST h | r) a
293+
85
294
86
295