Code Monkey home page Code Monkey logo

apollo's Introduction

Apollo

Package Version Hex Docs

A validation library named after the God of truth and prophecy.

An Basic Example

import gleam/io
import apollo/t
import apollo/filter as f

pub type Post {
  Post(id: String, timestamp: Int, title: String, content: String)
}

pub fn main() {
  let post_schema: t.Schema(Post) =
    apollo.typed(
      Post,
      [
        #(
          "id",
          t.string()
          |> f.min(4)
          |> f.max(10),
        ),
        #(
          "timestamp",
          t.int()
          |> f.length(10),
        ),
        #(
          "title",
          t.string()
          |> f.min(3)
          |> f.max(40),
        ),
        #("content", t.string()),
      ],
    )

  let post =
    apollo.validate(
      post_schema,
      #(
        #("id", "549"),
        // id should be at least 4 characters
        #("timestamp", 1_691_611_376),
        #("title", "Apollo, the God of Truth and Prophecy"),
        #(
          "content",
          "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
        ),
      ),
    )
  io.debug(post) // Error("Length of \"549\" is less than than 4")
}

Installation

This package can be added to your Gleam project:

gleam add apollo

and its documentation can be found at https://hexdocs.pm/apollo.

apollo's People

Contributors

enderchief avatar

Stargazers

Dave Lage avatar Ayodeji O. avatar  avatar Eszter avatar

Watchers

 avatar

Forkers

aosasona

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.