zod-opts/dist/example/complex.js

node.js CLI option parser / validator using Zod

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const zod_1 = require("zod");
// import { parser } from "zod-opts";
const index_1 = require("../src/index");
const parsed = (0, index_1.parser)()
    .name("scriptA") // script name on Usage
    .version("1.0.0") // version on Usage
    .options({
    option1: {
        // if default() is specified, it will be optional option.
        type: zod_1.z.string().describe("description of option").default("default"),
        argumentName: "NameA", // used in Usage.
    },
    option2: {
        type: zod_1.z
            .string()
            .regex(/[a-z]+/) // you can use zod's methods.
            .optional(), // if optional() is specified, it will be optional option and the parsed.option2 will be string | undefined.
    },
    option3: {
        type: zod_1.z.number().min(5), // accepts only number and greater than 5.
    },
    option4: {
        type: zod_1.z.enum(["a", "b", "c"]).default("b"), // accepts only "a", "b", "c" and default is "b".
    },
})
    .args([
    {
        // And required arguments.
        name: "arg1",
        type: zod_1.z.string(),
    },
])
    .parse();
// parsed is inferred as below.
// const parsed: {
//   option1: string;
//   option2?: string | undefined;
//   option3: number;
//   option4: "a" | "b" | "c";
//   arg1: string;
// }
console.log(parsed);
//# sourceMappingURL=complex.js.map