Skip to content

Commit

Permalink
Minor clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
th-awake committed Mar 3, 2020
1 parent 948a54b commit bdb2873
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/Data/Argonaut/Core.purs
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,8 @@ toBoolean = toJsonType caseJsonBoolean
toNumber :: Json -> Maybe Number
toNumber = toJsonType caseJsonNumber

-- | Convert `Json` to a `String` value, if the `Json` is a string.
-- | Convert `Json` to a `String` value, if the `Json` is a string. To write a
-- | `Json` value to a JSON string, see `stringify`.
toString :: Json -> Maybe String
toString = toJsonType caseJsonString

Expand Down Expand Up @@ -230,7 +231,8 @@ jsonSingletonArray j = fromArray [j]
jsonSingletonObject :: String -> Json -> Json
jsonSingletonObject key val = fromObject (Obj.singleton key val)

-- | Converts a `Json` value to a JSON string.
-- | Converts a `Json` value to a JSON string. To retrieve a string from a `Json`
-- | string value, see `fromString`.
foreign import stringify :: Json -> String

foreign import _caseJson
Expand Down
1 change: 1 addition & 0 deletions src/Data/Argonaut/Parser.purs
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ import Data.Function.Uncurried (Fn3, runFn3)
foreign import _jsonParser :: forall a. Fn3 (String -> a) (Json -> a) String a

-- | Parse a JSON string, constructing the `Json` value described by the string.
-- | To convert a string into a `Json` string, see `fromString`.
jsonParser :: String -> Either String Json
jsonParser j = runFn3 _jsonParser Left Right j

0 comments on commit bdb2873

Please sign in to comment.