git.iko.soy/rowtype-yoga/purescript-native
on e82e607 help sign in
rowtype-yoga/purescript-native/docs/source/prelude.rst
332 lines 6.5 kB history raw
1Module Documentation
2====================
4Module Prelude
5--------------
7Types
8~~~~~
10::
12 data Ordering where
13 LT :: Ordering
14 GT :: Ordering
15 EQ :: Ordering
17Type Classes
18~~~~~~~~~~~~
20::
22 class Alternative f where
23 empty :: forall a. f a
24 (<|>) :: forall a. f a -> f a -> f a
26 class Applicative f where
27 pure :: forall a. a -> f a
28 (<*>) :: forall a b. f (a -> b) -> f a -> f b
30 class Bits b where
31 (&) :: b -> b -> b
32 (|) :: b -> b -> b
33 (^) :: b -> b -> b
34 shl :: b -> Prim.Number -> b
35 shr :: b -> Prim.Number -> b
36 zshr :: b -> Prim.Number -> b
37 complement :: b -> b
39 class BoolLike b where
40 (&&) :: b -> b -> b
41 (||) :: b -> b -> b
42 not :: b -> b
44 class Category a where
45 id :: forall t. a t t
46 (<<<) :: forall b c d. a c d -> a b c -> a b d
48 class Eq a where
49 (==) :: a -> a -> Prim.Boolean
50 (/=) :: a -> a -> Prim.Boolean
52 class Functor f where
53 (<$>) :: forall a b. (a -> b) -> f a -> f b
55 class Monad m where
56 return :: forall a. a -> m a
57 (>>=) :: forall a b. m a -> (a -> m b) -> m b
59 class Num a where
60 (+) :: a -> a -> a
61 (-) :: a -> a -> a
62 (*) :: a -> a -> a
63 (/) :: a -> a -> a
64 (%) :: a -> a -> a
65 negate :: a -> a
67 class Ord a where
68 compare :: a -> a -> Ordering
70 class Show a where
71 show :: a -> Prim.String
73Type Class Instances
74~~~~~~~~~~~~~~~~~~~~
76::
78 instance applicativeFromMonad :: (Monad m) => Applicative m
80 instance bitsNumber :: Bits Prim.Number
82 instance boolLikeBoolean :: BoolLike Prim.Boolean
84 instance categoryArr :: Category Prim.Function
86 instance eqArray :: (Eq a) => Eq [a]
88 instance eqBoolean :: Eq Prim.Boolean
90 instance eqNumber :: Eq Prim.Number
92 instance eqString :: Eq Prim.String
94 instance functorFromApplicative :: (Applicative f) => Functor f
96 instance numNumber :: Num Prim.Number
98 instance ordNumber :: Ord Prim.Number
100 instance showBoolean :: Show Prim.Boolean
102 instance showNumber :: Show Prim.Number
104 instance showOrdering :: Show Ordering
106 instance showString :: Show Prim.String
108Values
109~~~~~~
111::
113 (!!) :: forall a. [a] -> Prim.Number -> a
115 (#) :: forall a b. a -> (a -> b) -> b
117 ($) :: forall a b. (a -> b) -> a -> b
119 (++) :: Prim.String -> Prim.String -> Prim.String
121 (<) :: forall a. (Ord a) => a -> a -> Prim.Boolean
123 (<=) :: forall a. (Ord a) => a -> a -> Prim.Boolean
125 (>) :: forall a. (Ord a) => a -> a -> Prim.Boolean
127 (>=) :: forall a. (Ord a) => a -> a -> Prim.Boolean
129 (>>>) :: forall a b c d. (Category a) => a b c -> a c d -> a b d
131 boolAnd :: Prim.Boolean -> Prim.Boolean -> Prim.Boolean
133 boolNot :: Prim.Boolean -> Prim.Boolean
135 boolOr :: Prim.Boolean -> Prim.Boolean -> Prim.Boolean
137 const :: forall a b. a -> b -> a
139 flip :: forall a b c. (a -> b -> c) -> b -> a -> c
141 numAdd :: Prim.Number -> Prim.Number -> Prim.Number
143 numAnd :: Prim.Number -> Prim.Number -> Prim.Number
145 numCompare :: Prim.Number -> Prim.Number -> Ordering
147 numComplement :: Prim.Number -> Prim.Number
149 numDiv :: Prim.Number -> Prim.Number -> Prim.Number
151 numMod :: Prim.Number -> Prim.Number -> Prim.Number
153 numMul :: Prim.Number -> Prim.Number -> Prim.Number
155 numNegate :: Prim.Number -> Prim.Number
157 numOr :: Prim.Number -> Prim.Number -> Prim.Number
159 numShl :: Prim.Number -> Prim.Number -> Prim.Number
161 numShr :: Prim.Number -> Prim.Number -> Prim.Number
163 numSub :: Prim.Number -> Prim.Number -> Prim.Number
165 numXor :: Prim.Number -> Prim.Number -> Prim.Number
167 numZshr :: Prim.Number -> Prim.Number -> Prim.Number
169 on :: forall a b c. (b -> b -> c) -> (a -> b) -> a -> a -> c
171 refEq :: forall a. a -> a -> Prim.Boolean
173 refIneq :: forall a. a -> a -> Prim.Boolean
175 showNumberImpl :: Prim.Number -> Prim.String
177Module Data.Eq
178--------------
180Types
181~~~~~
183::
185 data Ref a where
186 Ref :: a -> Ref a
188Type Classes
189~~~~~~~~~~~~
191Type Class Instances
192~~~~~~~~~~~~~~~~~~~~
194::
196 instance eqRef :: Eq (Ref a)
198Values
199~~~~~~
201::
203 liftRef :: forall a b. (a -> a -> b) -> Ref a -> Ref a -> b
205Module Control.Monad.Eff
206------------------------
208Types
209~~~~~
211::
213 data Eff :: # ! -> * -> *
215 type Pure a = forall e. Eff e a
217Type Classes
218~~~~~~~~~~~~
220Type Class Instances
221~~~~~~~~~~~~~~~~~~~~
223::
225 instance monadEff :: Monad (Eff e)
227Values
228~~~~~~
230::
232 bindEff :: forall e a b. Eff e a -> (a -> Eff e b) -> Eff e b
234 forE :: forall e. Prim.Number -> Prim.Number -> (Prim.Number -> Eff e { }) -> Eff e { }
236 foreachE :: forall e a. [a] -> (a -> Eff e { }) -> Eff e { }
238 retEff :: forall e a. a -> Eff e a
240 runPure :: forall a. Pure a -> a
242 untilE :: forall e. Eff e Prim.Boolean -> Eff e { }
244 whileE :: forall e a. Eff e Prim.Boolean -> Eff e a -> Eff e { }
246Module Control.Monad.Eff.Unsafe
247-------------------------------
249Types
250~~~~~
252Type Classes
253~~~~~~~~~~~~
255Type Class Instances
256~~~~~~~~~~~~~~~~~~~~
258Values
259~~~~~~
261::
263 unsafeInterleaveEff :: forall eff1 eff2 a. Eff eff1 a -> Eff eff2 a
265Module Debug.Trace
266------------------
268Types
269~~~~~
271::
273 data Trace :: !
275Type Classes
276~~~~~~~~~~~~
278Type Class Instances
279~~~~~~~~~~~~~~~~~~~~
281Values
282~~~~~~
284::
286 print :: forall a r. (Show a) => a -> Eff (trace :: Trace | r) { }
288 trace :: forall r. Prim.String -> Eff (trace :: Trace | r) { }
290Module Control.Monad.ST
291-----------------------
293Types
294~~~~~
296::
298 data ST :: * -> !
300 data STArray :: * -> * -> *
302 data STRef :: * -> * -> *
304Type Classes
305~~~~~~~~~~~~
307Type Class Instances
308~~~~~~~~~~~~~~~~~~~~
310Values
311~~~~~~
313::
315 modifySTRef :: forall a h r. STRef h a -> (a -> a) -> Eff (st :: ST h | r) a
317 newSTArray :: forall a h r. Prim.Number -> a -> Eff (st :: ST h | r) (STArray h a)
319 newSTRef :: forall a h r. a -> Eff (st :: ST h | r) (STRef h a)
321 peekSTArray :: forall a h r. STArray h a -> Eff (st :: ST h | r) a
323 pokeSTArray :: forall a h r. STArray h a -> Prim.Number -> a -> Eff (st :: ST h | r) a
325 readSTRef :: forall a h r. STRef h a -> Eff (st :: ST h | r) a
327 runST :: forall a r. (forall h. Eff (st :: ST h | r) a) -> Eff r a
329 runSTArray :: forall a r. (forall h. Eff (st :: ST h | r) (STArray h a)) -> Eff r [a]
331 writeSTRef :: forall a h r. STRef h a -> a -> Eff (st :: ST h | r) a