Yantrix

@yantrix/cli v0.5.2 • Docs

Yantrix API / @yantrix/cli / IArgv

Interface: IArgv ​

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

Properties ​

_ ​

ts
_: (string | number)[];

Additional arguments.

beautify? ​

ts
optional beautify: boolean;

Format generated code using Prettier (JS/TS) or ruff (Python).

class-name? ​

ts
optional class-name: string;

The name of the generated Automata class.

className? ​

ts
optional className: string;

The name of the generated Automata class.

constantFile? ​

ts
optional constantFile: string;

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

constants? ​

ts
optional constants: string;

Stringified JSON with constants to be used in generated Automata.

constants-file? ​

ts
optional constants-file: string;

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

diagram-file? ​

ts
optional diagram-file: string;

Path to the file containing the state diagram.

diagramFile? ​

ts
optional diagramFile: string;

Path to the file containing the state diagram.

eval? ​

ts
optional eval: string;

Evaluate the given state diagram.

functionFile? ​

ts
optional functionFile: string;

Path to .js/.ts (or .py) file containing injectable user-defined functions.

interactive? ​

ts
optional interactive: boolean;

Enter interactive mode.

language? ​

ts
optional language: string;

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

outfile? ​

ts
optional outfile: string;

The output file path.

verbose? ​

ts
optional verbose: boolean;

Verbose mode.