@campfhir/node-args v0.1.0

NodeArgs

A simple library that parses out Node.process.argv into a more easily accessible object.

API

Using the parse(arguments, map) API will generate a ProgramArguments object.

Example

const example1 = [
  "/usr/bin/node",
  "/home/user/project/index.js",
  "-d",
  "/var/logs",
  "--verbose",
  "-c",
  "20",
  "-e",
  "true",
  "-net",
  "0",
  "-dl",
  "yup",
  "-u",
];

// This map tells the arguments how to identify options in the CLI, optional what the default value is if undefined, and tries to type cast based on optional type property (default: "string")
const argumentMap: ArgumentMap = {
  logDirectory: {
    optionVariants: ["-d", "--directory"],
    defaultValue: "/var/logs",
    type: "string",
  },
  debug: {
    optionVariants: ["--debug"],
    defaultValue: false,
    type: "boolean",
  },
  port: {
    optionVariants: ["-p", "--port"],
    type: "number",
  },
  verbose: {
    optionVariants: ["-v", "--verbose"],
    toggleFlag: true,
    type: "boolean",
  },
  numberOfConnections: {
    optionVariants: ["-c"],
    type: "number",
  },
  useTls: {
    optionVariants: ["-tls", "-e"],
    type: "boolean",
  },
  allowNetworking: {
    optionVariants: ["-net"],
    type: "boolean",
  },
  allowDownload: {
    optionVariants: ["-dl"],
    type: "boolean",
  },
  unknown: {
    optionVariants: ["-u"],
  },
};
const programArguments = NodeArgs.parse(example1, argumentMap);
expect(programArguments["logDirectory"]).to.equal(example1[3]);
expect(programArguments["debug"]).to.be.false;
expect(programArguments["port"]).to.be.undefined;
expect(programArguments["verbose"]).to.be.true;
expect(programArguments["numberOfConnection"]).to.be.undefined;