Skip to main content
Module

x/value_schema/test/schemas/enumeration.test.ts

simple, easy-to-use, and declarative input validator; supports Node.js, TypeScript, Deno, and Bun
Latest
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899
import {describe, expect, it} from "@jest/globals";import vs from "value-schema";
// enumenum NumberEnum{ zero, one,}enum StringEnum{ a = "a", b = "b",}enum NumberAndStringEnum{ zero, one, a = "a", b = "b",}
// const enumconst enum ConstStringEnum{ a = "a", b = "b",}
// uniontype NumberUnion = 0 | 1;type StringUnion = "a" | "b";type NumberAndStringUnion = 0 | 1 | "a" | "b";
{ describe("ifUndefined", testIfUndefined); describe("ifNull", testIfNull); describe("ifEmptyString", testIfEmptyString); describe("only", testOnly);}
/** * if undefined */function testIfUndefined(): void{ it("should be OK (enum)", () => { { const val: NumberEnum | null = vs.enumeration({ ifUndefined: null, only: [NumberEnum.zero, NumberEnum.one], }).applyTo(0); expect(val).toEqual(0); } { const val: StringEnum | null = vs.enumeration({ ifUndefined: null, only: Object.values(StringEnum), // string elements can be extracted by "Object.values()" }).applyTo("a"); expect(val).toEqual("a"); } { const val: ConstStringEnum | null = vs.enumeration({ ifUndefined: null, only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo("a"); expect(val).toEqual("a"); } { const val: NumberAndStringEnum | null = vs.enumeration({ ifUndefined: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(0); expect(val).toEqual(0); } { // "as const" version const val: NumberAndStringEnum | null = vs.enumeration({ ifUndefined: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b] as const, }).applyTo("a"); expect(val).toEqual("a"); } }); it("should be OK (union)", () => { { const val: NumberUnion | null = vs.enumeration({ ifUndefined: null, only: [0, 1] as const, }).applyTo(0); expect(val).toEqual(0); } { const val: StringUnion | null = vs.enumeration({ ifUndefined: null, only: ["a", "b"] as const, }).applyTo("a"); expect(val).toEqual("a"); } { const val: NumberAndStringUnion | null = vs.enumeration({ ifUndefined: null, only: [0, 1, "a", "b"] as const, }).applyTo(0); expect(val).toEqual(0); } { // generics version const val: NumberAndStringUnion | null = vs.enumeration<NumberAndStringUnion>({ ifUndefined: null, only: [0, 1, "a", "b"], }).applyTo("a"); expect(val).toEqual("a"); } });
it("should be adjusted (enum)", () => { { const val: NumberEnum | null = vs.enumeration({ ifUndefined: null, only: [NumberEnum.zero, NumberEnum.one], }).applyTo(undefined); expect(val).toEqual(null); } { const val: StringEnum | null = vs.enumeration({ ifUndefined: null, only: Object.values(StringEnum), }).applyTo(undefined); expect(val).toEqual(null); } { const val: ConstStringEnum | null = vs.enumeration({ ifUndefined: null, only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo(undefined); expect(val).toEqual(null); } { const val: NumberAndStringEnum | null = vs.enumeration({ ifUndefined: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(undefined); expect(val).toEqual(null); } }); it("should be adjusted (union)", () => { { const val: NumberUnion | null = vs.enumeration({ ifUndefined: null, only: [0, 1] as const, }).applyTo(undefined); expect(val).toEqual(null); } { const val: StringUnion | null = vs.enumeration({ ifUndefined: null, only: ["a", "b"] as const, }).applyTo(undefined); expect(val).toEqual(null); } { const val: NumberAndStringUnion | null = vs.enumeration({ ifUndefined: null, only: [0, 1, "a", "b"] as const, }).applyTo(undefined); expect(val).toEqual(null); } });
it("should be undefined (enum)", () => { expect( vs.enumeration({ only: [NumberEnum.zero, NumberEnum.one], ifUndefined: undefined, }).applyTo(undefined) ).toBeUndefined(); }); it("should be undefined (union)", () => { expect( vs.enumeration({ only: [0, 1] as const, ifUndefined: undefined, }).applyTo(undefined) ).toBeUndefined(); });
it("should cause error(s) (enum)", () => { expect(() => { const val: NumberEnum = vs.enumeration({ only: [NumberEnum.zero, NumberEnum.one], }).applyTo(undefined);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.UNDEFINED);
expect(() => { const val: StringEnum = vs.enumeration({ only: Object.values(StringEnum), }).applyTo(undefined);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.UNDEFINED);
expect(() => { const val: ConstStringEnum = vs.enumeration({ only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo(undefined);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.UNDEFINED);
expect(() => { const val: NumberAndStringEnum = vs.enumeration({ only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(undefined);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.UNDEFINED); }); it("should cause error(s) (union)", () => { expect(() => { const val: NumberUnion = vs.enumeration({ only: [0, 1] as const, }).applyTo(undefined);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.UNDEFINED);
expect(() => { const val: StringUnion = vs.enumeration({ only: ["a", "b"] as const, }).applyTo(undefined);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.UNDEFINED);
expect(() => { const val: NumberAndStringUnion = vs.enumeration({ only: [0, 1, "a", "b"] as const, }).applyTo(undefined);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.UNDEFINED); });}
/** * if null */function testIfNull(): void{ it("should be OK (enum)", () => { { const val: NumberEnum | null = vs.enumeration({ ifNull: null, only: [NumberEnum.zero, NumberEnum.one], }).applyTo(0); expect(val).toEqual(0); } { const val: StringEnum | null = vs.enumeration({ ifNull: null, only: Object.values(StringEnum), }).applyTo("a"); expect(val).toEqual("a"); } { const val: ConstStringEnum | null = vs.enumeration({ ifNull: null, only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo("a"); expect(val).toEqual("a"); } { const val: NumberAndStringEnum | null = vs.enumeration({ ifNull: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(0); expect(val).toEqual(0); } { // "as const" version const val: NumberAndStringEnum | null = vs.enumeration({ ifNull: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b] as const, }).applyTo("a"); expect(val).toEqual("a"); } }); it("should be OK (union)", () => { { const val: NumberUnion | null = vs.enumeration({ ifNull: null, only: [0, 1] as const, }).applyTo(0); expect(val).toEqual(0); } { const val: StringUnion | null = vs.enumeration({ ifNull: null, only: ["a", "b"] as const, }).applyTo("a"); expect(val).toEqual("a"); } { const val: NumberAndStringUnion | null = vs.enumeration({ ifNull: null, only: [0, 1, "a", "b"] as const, }).applyTo(0); expect(val).toEqual(0); } { // generics version const val: NumberAndStringUnion | null = vs.enumeration<NumberAndStringUnion>({ ifNull: null, only: [0, 1, "a", "b"], }).applyTo("a"); expect(val).toEqual("a"); } });
it("should be adjusted (enum)", () => { { const val: NumberEnum | null = vs.enumeration({ ifNull: null, only: [NumberEnum.zero, NumberEnum.one], }).applyTo(null); expect(val).toEqual(null); } { const val: StringEnum | null = vs.enumeration({ ifNull: null, only: Object.values(StringEnum), }).applyTo(null); expect(val).toEqual(null); } { const val: ConstStringEnum | null = vs.enumeration({ ifNull: null, only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo(null); expect(val).toEqual(null); } { const val: NumberAndStringEnum | null = vs.enumeration({ ifNull: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(null); expect(val).toEqual(null); } }); it("should be adjusted (union)", () => { { const val: NumberUnion | null = vs.enumeration({ ifNull: null, only: [0, 1] as const, }).applyTo(null); expect(val).toEqual(null); } { const val: StringUnion | null = vs.enumeration({ ifNull: null, only: ["a", "b"] as const, }).applyTo(null); expect(val).toEqual(null); } { const val: NumberAndStringUnion | null = vs.enumeration({ ifNull: null, only: [0, 1, "a", "b"] as const, }).applyTo(null); expect(val).toEqual(null); } });
it("should cause error(s) (enum)", () => { expect(() => { const val: NumberEnum = vs.enumeration({ only: [NumberEnum.zero, NumberEnum.one], }).applyTo(null);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.NULL);
expect(() => { const val: StringEnum = vs.enumeration({ only: Object.values(StringEnum), }).applyTo(null);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.NULL);
expect(() => { const val: ConstStringEnum = vs.enumeration({ only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo(null);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.NULL);
expect(() => { const val: NumberAndStringEnum = vs.enumeration({ only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(null);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.NULL); }); it("should cause error(s) (union)", () => { expect(() => { const val: NumberUnion = vs.enumeration({ only: [0, 1] as const, }).applyTo(null);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.NULL);
expect(() => { const val: StringUnion = vs.enumeration({ only: ["a", "b"] as const, }).applyTo(null);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.NULL);
expect(() => { // generics version const val: NumberAndStringUnion = vs.enumeration<NumberAndStringUnion>({ only: [0, 1, "a", "b"], }).applyTo(null);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.NULL); });}
/** * if empty string */function testIfEmptyString(): void{ it("should be OK (enum)", () => { { const val: NumberEnum | null = vs.enumeration({ ifEmptyString: null, only: [NumberEnum.zero, NumberEnum.one], }).applyTo(0); expect(val).toEqual(0); } { const val: StringEnum | null = vs.enumeration({ ifEmptyString: null, only: Object.values(StringEnum), // string elements can be extracted by "Object.values()" }).applyTo("a"); expect(val).toEqual("a"); } { const val: ConstStringEnum | null = vs.enumeration({ ifEmptyString: null, only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo("a"); expect(val).toEqual("a"); } { const val: NumberAndStringEnum | null = vs.enumeration({ ifEmptyString: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(0); expect(val).toEqual(0); } { // "as const" version const val: NumberAndStringEnum | null = vs.enumeration({ ifEmptyString: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b] as const, }).applyTo("a"); expect(val).toEqual("a"); } }); it("should be OK (union)", () => { { const val: NumberUnion | null = vs.enumeration({ ifEmptyString: null, only: [0, 1] as const, }).applyTo(0); expect(val).toEqual(0); } { const val: StringUnion | null = vs.enumeration({ ifEmptyString: null, only: ["a", "b"] as const, }).applyTo("a"); expect(val).toEqual("a"); } { const val: NumberAndStringUnion | null = vs.enumeration({ ifEmptyString: null, only: [0, 1, "a", "b"] as const, }).applyTo(0); expect(val).toEqual(0); } { // generics version const val: NumberAndStringUnion | null = vs.enumeration<NumberAndStringUnion>({ ifEmptyString: null, only: [0, 1, "a", "b"], }).applyTo("a"); expect(val).toEqual("a"); } });
it("should be adjusted (enum)", () => { { const val: NumberEnum | null = vs.enumeration({ ifEmptyString: null, only: [NumberEnum.zero, NumberEnum.one], }).applyTo(""); expect(val).toEqual(null); } { const val: StringEnum | null = vs.enumeration({ ifEmptyString: null, only: Object.values(StringEnum), }).applyTo(""); expect(val).toEqual(null); } { const val: ConstStringEnum | null = vs.enumeration({ ifEmptyString: null, only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo(""); expect(val).toEqual(null); } { const val: NumberAndStringEnum | null = vs.enumeration({ ifEmptyString: null, only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(""); expect(val).toEqual(null); } }); it("should be adjusted (union)", () => { { const val: NumberUnion | null = vs.enumeration({ ifEmptyString: null, only: [0, 1] as const, }).applyTo(""); expect(val).toEqual(null); } { const val: StringUnion | null = vs.enumeration({ ifEmptyString: null, only: ["a", "b"] as const, }).applyTo(""); expect(val).toEqual(null); } { const val: NumberAndStringUnion | null = vs.enumeration({ ifEmptyString: null, only: [0, 1, "a", "b"] as const, }).applyTo(""); expect(val).toEqual(null); } });
it("should cause error(s) (enum)", () => { expect(() => { const val: NumberEnum = vs.enumeration({ only: [NumberEnum.zero, NumberEnum.one], }).applyTo("");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.EMPTY_STRING);
expect(() => { const val: StringEnum = vs.enumeration({ only: Object.values(StringEnum), }).applyTo("");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.EMPTY_STRING);
expect(() => { const val: ConstStringEnum = vs.enumeration({ only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo("");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.EMPTY_STRING);
expect(() => { const val: NumberAndStringEnum = vs.enumeration({ only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo("");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.EMPTY_STRING); }); it("should cause error(s) (union)", () => { expect(() => { const val: NumberUnion = vs.enumeration({ only: [0, 1] as const, }).applyTo("");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.EMPTY_STRING);
expect(() => { const val: StringUnion = vs.enumeration({ only: ["a", "b"] as const, }).applyTo("");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.EMPTY_STRING);
expect(() => { const val: NumberAndStringUnion = vs.enumeration({ only: [0, 1, "a", "b"] as const, }).applyTo("");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.EMPTY_STRING); });}
/** * only */function testOnly(): void{ it("should be OK (enum)", () => { { const val: NumberEnum = vs.enumeration({ only: [NumberEnum.zero, NumberEnum.one], }).applyTo(0); expect(val).toEqual(0); } { const val: NumberEnum = vs.enumeration({ only: [NumberEnum.zero, NumberEnum.one], }).applyTo(1); expect(val).toEqual(1); }
{ const val: StringEnum = vs.enumeration({ only: Object.values(StringEnum), }).applyTo("a"); expect(val).toEqual("a"); } { const val: StringEnum = vs.enumeration({ only: Object.values(StringEnum), }).applyTo("b"); expect(val).toEqual("b"); }
{ const val: ConstStringEnum = vs.enumeration({ only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo("a"); expect(val).toEqual("a"); } { const val: ConstStringEnum = vs.enumeration({ only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo("b"); expect(val).toEqual("b"); }
{ const val: NumberAndStringEnum = vs.enumeration({ only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(0); expect(val).toEqual(0); } { const val: NumberAndStringEnum = vs.enumeration({ only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo(1); expect(val).toEqual(1); } { const val: NumberAndStringEnum = vs.enumeration({ only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo("a"); expect(val).toEqual("a"); } { const val: NumberAndStringEnum = vs.enumeration({ only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo("b"); expect(val).toEqual("b"); } }); it("should be OK (union)", () => { { const val: NumberUnion = vs.enumeration({ only: [0, 1] as const, }).applyTo(0); expect(val).toEqual(0); } { const val: NumberUnion = vs.enumeration({ only: [0, 1] as const, }).applyTo(1); expect(val).toEqual(1); }
{ const val: StringUnion = vs.enumeration({ only: ["a", "b"] as const, }).applyTo("a"); expect(val).toEqual("a"); } { const val: StringUnion = vs.enumeration({ only: ["a", "b"] as const, }).applyTo("b"); expect(val).toEqual("b"); }
{ const val: NumberAndStringUnion = vs.enumeration({ only: [0, 1, "a", "b"] as const, }).applyTo(0); expect(val).toEqual(0); } { const val: NumberAndStringUnion = vs.enumeration({ only: [0, 1, "a", "b"] as const, }).applyTo(1); expect(val).toEqual(1); } { // generics version const val: NumberAndStringUnion = vs.enumeration<NumberAndStringUnion>({ only: [0, 1, "a", "b"], }).applyTo("a"); expect(val).toEqual("a"); } { // generics version const val: NumberAndStringUnion = vs.enumeration<NumberAndStringUnion>({ only: [0, 1, "a", "b"], }).applyTo("b"); expect(val).toEqual("b"); }
{ const only = [0, 1] as const; const val: NumberUnion = vs.enumeration({ only: only, }).applyTo(1); expect(val).toEqual(1); } });
it("should cause error(s) (enum)", () => { expect(() => { const val: NumberEnum = vs.enumeration({ only: [NumberEnum.zero, NumberEnum.one], }).applyTo(2);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.ONLY);
expect(() => { const val: StringEnum = vs.enumeration({ only: Object.values(StringEnum), }).applyTo("c");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.ONLY);
expect(() => { const val: ConstStringEnum = vs.enumeration({ only: [ConstStringEnum.a, ConstStringEnum.b], }).applyTo("c");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.ONLY);
expect(() => { const val: NumberAndStringEnum = vs.enumeration({ only: [NumberAndStringEnum.zero, NumberAndStringEnum.one, NumberAndStringEnum.a, NumberAndStringEnum.b], }).applyTo("x");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.ONLY); }); it("should cause error(s) (union)", () => { expect(() => { const val: NumberUnion = vs.enumeration({ only: [0, 1] as const, }).applyTo(2);
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.ONLY);
expect(() => { const val: StringUnion = vs.enumeration({ only: ["a", "b"] as const, }).applyTo("c");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.ONLY);
expect(() => { const val: NumberAndStringUnion = vs.enumeration<NumberAndStringUnion>({ only: [0, 1, "a", "b"], }).applyTo("x");
// unreachable expect(val).toBeNaN(); }).toThrow(vs.RULE.ONLY); });}