Skip to content

Commit d76c542

Browse files
committed
Add generated docs
1 parent c0662b4 commit d76c542

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

README.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Module Documentation
2+
3+
## Module Data.Foldable
4+
5+
### Type Classes
6+
7+
class Foldable f where
8+
foldr :: forall a b. (a -> b -> b) -> b -> f a -> b
9+
foldl :: forall a b. (b -> a -> b) -> b -> f a -> b
10+
foldMap :: forall a m. (Monoid m) => (a -> m) -> f a -> m
11+
12+
13+
### Type Class Instances
14+
15+
instance foldableArray :: Foldable Prim.Array
16+
17+
instance foldableEither :: Foldable (Either a)
18+
19+
instance foldableMaybe :: Foldable Maybe
20+
21+
instance foldableRef :: Foldable Ref
22+
23+
instance foldableTuple :: Foldable (Tuple a)
24+
25+
26+
### Values
27+
28+
all :: forall a f. (Foldable f) => (a -> Prim.Boolean) -> f a -> Prim.Boolean
29+
30+
and :: forall f. (Foldable f) => f Prim.Boolean -> Prim.Boolean
31+
32+
any :: forall a f. (Foldable f) => (a -> Prim.Boolean) -> f a -> Prim.Boolean
33+
34+
elem :: forall a f. (Eq a, Foldable f) => a -> f a -> Prim.Boolean
35+
36+
find :: forall a f. (Foldable f) => (a -> Prim.Boolean) -> f a -> Maybe a
37+
38+
fold :: forall f m. (Foldable f, Monoid m) => f m -> m
39+
40+
foldlArray :: forall a b. (b -> a -> b) -> b -> [a] -> b
41+
42+
foldrArray :: forall a b. (a -> b -> b) -> b -> [a] -> b
43+
44+
for_ :: forall a b f m. (Functor m, Applicative m, Foldable f) => f a -> (a -> m b) -> m { }
45+
46+
mconcat :: forall f m. (Foldable f, Monoid m) => f m -> m
47+
48+
notElem :: forall a f. (Eq a, Foldable f) => a -> f a -> Prim.Boolean
49+
50+
or :: forall f. (Foldable f) => f Prim.Boolean -> Prim.Boolean
51+
52+
product :: forall f. (Foldable f) => f Prim.Number -> Prim.Number
53+
54+
sequence_ :: forall a f m. (Functor m, Applicative m, Foldable f) => f (m a) -> m { }
55+
56+
sum :: forall f. (Foldable f) => f Prim.Number -> Prim.Number
57+
58+
traverse_ :: forall a b f m. (Functor m, Applicative m, Foldable f) => (a -> m b) -> f a -> m { }
59+
60+
61+
62+
## Module Data.Traversable
63+
64+
### Type Classes
65+
66+
class Traversable t where
67+
traverse :: forall a b m. (Functor m, Applicative m) => (a -> m b) -> t a -> m (t b)
68+
sequence :: forall a m. (Functor m, Applicative m) => t (m a) -> m (t a)
69+
70+
71+
### Type Class Instances
72+
73+
instance traversableArray :: Traversable Prim.Array
74+
75+
instance traversableEither :: Traversable (Either a)
76+
77+
instance traversableMaybe :: Traversable Maybe
78+
79+
instance traversableRef :: Traversable Ref
80+
81+
instance traversableTuple :: Traversable (Tuple a)
82+
83+
84+
### Values
85+
86+
for :: forall a b m t. (Functor m, Applicative m, Traversable t) => t a -> (a -> m b) -> m (t b)
87+
88+
zipWithA :: forall m a b c. (Functor m, Applicative m) => (a -> b -> m c) -> [a] -> [b] -> m [c]
89+
90+
91+

0 commit comments

Comments
 (0)