purescript-yaml/docs/Data/YAML/Foreign/Decode.md

28 lines
549 B
Markdown
Raw Normal View History

2015-12-20 14:35:04 +00:00
## Module Data.YAML.Foreign.Decode
#### `parseYAML`
``` purescript
parseYAML :: String -> F Foreign
```
Attempt to parse a YAML string, returning the result as foreign data.
#### `readYAML`
``` purescript
readYAML :: forall a. IsForeign a => String -> F a
2015-12-20 14:35:04 +00:00
```
Attempt to parse a YAML string into the datastructure you want.
#### `readYAMLGeneric`
``` purescript
readYAMLGeneric :: forall a rep. (Generic a rep, GenericDecode rep) => Options -> String -> F a
2015-12-20 14:35:04 +00:00
```
Automatically generate a YAML parser for your data from a generic instance.