This package has been deprecated

Author message:

This package has reached end of life and is deprecated. Please refer to our support policy, https://www.itwinjs.org/learning/api-support-policies/, and changelog, https://www.itwinjs.org/v3/changehistory/3.0.0/#package-name-changes.

@bentley/ecschema2ts

ecschema2ts

ecschema2ts is a command-line tool that takes an EC3.1/EC3.2 BIS ECSchema xml file and outputs a valid Typescript module that uses iModelJs.

Quick Overview

$ npm install -g @bentley/ecschema2ts

$ ecschema2ts -i C:\Path\To\Schema\Domain.ecschema.xml -o C:\Desired\Output\Path\

Getting Started

Installation

Install globally:

$ npm install -g @bentley/ecschema2ts

Creating a Typescript module

To create a Typescript file from the an ECSchema, run:

$ ecschema2ts -i C:\Path\To\Schema\Domain.ecschema.xml -o C:\Desired\Output\Path\

Updating to new version

Since the package is installed globally, updating has a different syntax than normal. To update the package globally, run:

$ npm update -g @bentley/ecschema2ts

Known Issues

• The ordering of the Typescript classes may be out of order preventing compilation of the typescript file. A workaround is to reorder the classes by hand.

Troubleshooting

• Are you have issues converting your ECSchema?
  • Check to make sure your ECSchema version is EC3.1
  • Check if the BIS ECSchema passes validation, check ECSchema status.