Skip to content

Commit 0cb4232

Browse files
committed
Use generated docs
1 parent 5de1e92 commit 0cb4232

File tree

1 file changed

+51
-4
lines changed

1 file changed

+51
-4
lines changed

README.md

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,52 @@
1-
purescript-foreign
2-
==================
1+
# Module Documentation
2+
3+
## Module Data.Foreign
4+
5+
### Types
6+
7+
data Foreign :: *
8+
9+
data ForeignParser a where
10+
11+
12+
### Type Classes
13+
14+
class ReadForeign a where
15+
read :: ForeignParser a
16+
17+
18+
### Type Class Instances
19+
20+
instance applicativeForeignParser :: Prelude.Applicative ForeignParser
21+
22+
instance applyForeignParser :: Prelude.Apply ForeignParser
23+
24+
instance bindForeignParser :: Prelude.Bind ForeignParser
25+
26+
instance functorForeignParser :: Prelude.Functor ForeignParser
27+
28+
instance monadForeignParser :: Prelude.Monad ForeignParser
29+
30+
instance readArray :: (ReadForeign a) => ReadForeign [a]
31+
32+
instance readBoolean :: ReadForeign Prim.Boolean
33+
34+
instance readMaybe :: (ReadForeign a) => ReadForeign (Maybe a)
35+
36+
instance readNumber :: ReadForeign Prim.Number
37+
38+
instance readString :: ReadForeign Prim.String
39+
40+
instance showForeign :: Prelude.Show Foreign
41+
42+
43+
### Values
44+
45+
parseForeign :: forall a. ForeignParser a -> Foreign -> Either Prim.String a
46+
47+
parseJSON :: forall a. (ReadForeign a) => Prim.String -> Either Prim.String a
48+
49+
prop :: forall a. (ReadForeign a) => Prim.String -> ForeignParser a
50+
51+
352

4-
A work-in-progress PureScript library for dealing with JSON and
5-
Javascript objects in a type safe manner.

0 commit comments

Comments
 (0)