Code Monkey home page Code Monkey logo

kina's Introduction

Kina

Define and parse data structures.

Designed for the purpose of simplifying the process of building API clients, but has many potential use-cases.

Inspired by Ecto schemas, changesets will potentially be added in future.

Example implementation: https://github.com/insprac/elixir_kucoin

Installation

def deps do
  [
    {:kina, "~> 0.1.0"}
  ]
end

Usage

Define a schema and it's fields.

defmodule MyApp.User do
  use Kina.Schema

  schema do
    field :username, :string
    field :password, :string
    field :emails, {:list, MyApp.UserEmail}
  end
end

defmodule MyApp.UserEmail do
  use Kina.Schema

  schema do
    field :email, :string
    field :verified, :boolean
  end
end

Parse the data coming from something like JSON.

data = %{
  "username" => "insprac",
  "password" => "password",
  "emails" => [
    %{
      "email" => "[email protected]",
      "verified" => true
    }
  ]
}

Kina.Parser.parse(data, MyApp.User)
# %MyApp.User{
#   username: "insprac",
#   password: "password",
#   emails: [
#     %MyApp.UserEmail{
#       email: "[email protected]",
#       verified: true
#     }
#   ]
# }

kina's People

Contributors

insprac avatar

Stargazers

Pete Birkinshaw avatar

Watchers

 avatar  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.