@yantrix/cli v0.0.2 • Docs

---

Yantrix API / @yantrix/cli / IArgv

Interface: IArgv

Interface that represents the arguments that can be passed to the CLI.

Properties

_

_: (string | number)[];

Additional arguments.

---

class-name?

optional class-name: string;

The name of the generated Automata class.

---

className?

optional className: string;

The name of the generated Automata class.

---

constantFile?

optional constantFile: string;

Path to JSON file with constants to be used in generated Automata.

---

constants?

optional constants: string;

Stringified JSON with constants to be used in generated Automata.

---

constants-file?

optional constants-file: string;

Path to JSON file with constants to be used in generated Automata.

---

diagram-file?

optional diagram-file: string;

Path to the file containing the state diagram.

---

diagramFile?

optional diagramFile: string;

Path to the file containing the state diagram.

---

eval?

optional eval: string;

Evaluate the given state diagram.

---

interactive?

optional interactive: boolean;

Enter interactive mode.

---

language?

optional language: string;

The language to generate the code in. See list of supported languages here.

---

outfile?

optional outfile: string;

The output file path.

---

verbose?

optional verbose: boolean;

Verbose mode.