phel-lang / phel-schema

phel 中的模式验证库。该库受到 zod 的启发

维护者

详细信息

github.com/phel-lang/phel-schema

源代码

问题

安装: 4

依赖: 0

建议者: 0

安全: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

v0.0.0 2024-06-24 15:57 UTC

Requires

MIT 9ed29ee38ff037a95e2739cf4251bc0594d319c3

  • smeghead <smeghead7.woop@gmail.com>

schemavalidationphelzod

This package is auto-updated.

Last update: 2024-09-24 23:26:21 UTC

README

phel 中的模式验证库。该库受到 zod 的启发

基本用法

创建简单的字符串模式

(ns app
  (:require phel\schema :as z))

# creating a schema for strings
(def my-schema (z/string))

# parsing
(z/parse my-schema "tuna") # => "tuna"
(z/parse my-schema 12) # => throws ZodError

# "safe" parsing (doesn't throw error if validation fails)
(z/safe-parse my-schema "tuna") # => {:success true :data "tuna"}
(z/safe-parse my-schema 12) # => {:success false :error ZodError :issues [...]}
(ns app
  (:require phel\schema :as z))

# creating a schema for strings
(def my-schema (as-> (z/string) s
                     (z/min s 3)
                     (z/max s 10)
                     (z/regex s "/^t/")))

# parsing
(z/parse my-schema "tuna") # => "tuna"
(z/parse my-schema "a tuna") # => throws ZodError

创建对象模式

(ns app
  (:require phel\schema :as z))

(def user-schama (z/object {
  :username (z/string)
}))

(z/parse user-schama {:username "Ludwig"})

# extract the inferred type
(z/infer user-schama)
# { username: string }

原始数据类型

(ns app
  (:require phel\schema :as z))

# primitive values
(z/string)
(z/number)
(z/bigint)
(z/boolean)
(z/date)
(z/symbol)

# empty types
(z/undefined)
(z/null)
(z/void) # accepts undefined

# catch-all types
# allows any value
(z/any)
(z/unknown)

# never type
# allows no values
(z/never)

开发

打开壳

docker compose build
docker compose run --rm php_cli bash

测试

# vendor/bin/phel test