Giter Club home page Giter Club logo

json-to-elm's Introduction

json-to-elm

Decodes JSON into a custom Elm type and provides helpers for generating encoders and decoders for that with elm-codegen.

When to Use

This package was designed and built to help with taking JSON of an unknown shape and generating code for encoding / decoding it with elm-codegen. I'm not sure if there are many good uses for this package beyond that use-case!

Quick Start

To get started, run the decode function with some JSON. This can be JSON encoded in your Elm app or JSON from an external source, like flags or ports.

decodeToElm : Json.Decode.Value -> Result Json.Decode.Error JsonToElm.Value
decodeToElm json =
    Json.Decode.decodeValue JsonToElm.decode json

If the JSON passed to the function above had this shape:

{
    "name": "Joshua",
    "friends": ["John", "Cindy", "Leslie"],
    "active": "true"
}

It would result in the following JsonToElm.Value being returned:

JsonToElm.Record
    (Dict.fromList 
        [ ( "name", JsonToElm.StringVal "Joshua" )
        , ( "friends"
          , JsonToElm.ListVal 
            [ JsonToElm.StringVal "John"
            , JsonToElm.StringVal "Cindy"
            , JsonToElm.StringVal "Leslie"
            ] 
          )
        , ( "active", JsonToElm.BoolVal True )
        ]
    )

json-to-elm's People

Contributors

joeybright avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.