Union type

[shimataro]

Like this:

import assert from "assert";
import vs from "value-schema";

// accepts both number and integer
const schema = vs.union({
    schemas: [vs.number(), vs.string()],
});

assert.strictEqual(schema.applyTo(1), 1);
assert.strictEqual(schema.applyTo("a"), "a");

[shimataro]

interface

const schema = vs.union(vs.number(), vs.string());
assert.strictEqual(schema.applyTo(1), 1);

examples

// should be OK
assert.strictEqual(
    vs.union(vs.number(), vs.string()).applyTo(1),
    1);
assert.strictEqual(
    vs.union(vs.number(), vs.string()).applyTo("a"),
    "a");

// should be adjusted
assert.strictEqual(
    vs.union(vs.number(), vs.string()).applyTo("1"),
    1);
assert.strictEqual(
    vs.union(vs.string(), vs.number()).applyTo("1"), // this won't be adjusted. be careful of schemas order!
    "1");

// should cause error
assert.throws(
    () => vs.union(vs.number(), vs.string()).applyTo({}),
    {name: "ValueSchemaError", cause: vs.CAUSE.TYPE});