README.md

The Valkyrie Package

Version 0.1.0

This package implements type validation, and is targetted mainly at package and template developers. The desired outcome is that it becomes easier for the programmer to quickly put a package together without spending a long time on type safety, but also to make the usage of those packages by end-users less painful by generating useful error messages.

Example Usage

#import "@preview/valkyrie:0.1.0" as z

#let my-schema = z.dictionary(
    should-be-string: z.string(),
    complicated-tuple: z.tuple(
        z.email(),
        z.ip(),
        z.either(
            z.string(),
            z.number()
        )
    )
)

#z.parse(
    (
        should-be-string: "This doesn't error",
        complicated-tuple: (
            "neither@does-this.com",
            "NOT AN IP", // Error: Schema validation failed on argument.complicated-tuple.1: 
                         //        String must be a valid IP address
            1 
        )
    ),
    my-schema
)