Generates TypeScript type definitions for the specified schema and writes them to the specified file.

​
Usage

typesync generate-ts --definition <filePathOrPattern> --target <targetEnvironment> --outFile <filePath> --indentation <indentation> --debug <debug>

​
Options

​
definition
string
required

The exact path or a Glob pattern to the definition file or files. Each definition file must be a YAML or JSON file containing model definitions.

  • Example single file path: definition/models.json
  • Example Glob pattern: 'definition/**/*.yml'
​
target
string
required

The target environment for which the types are generated. This option specifies the target SDK and version, ensuring that the output is compatible with the chosen environment. See the list of available targets here.

​
outFile
string
required

The path to the output file.

​
objectTypeFormat
"interface" | "type-alias"
default:"interface"

Controls how objects are defined in the TypeScript output. Object types can be represented either by interfaces or type aliases.

​
indentation
int
default:2

Indentation or tab width for the generated code.

​
debug
boolean
default:false

Whether to enable debug logs.

​
Targets