search

cap-js / cds-typer

CDS type generator for JavaScript
Apache License 2.0
29 stars 10 forks source link
cap cds javascript nodejs plugin sap-cap

readme

CDS type generator for JavaScript

REUSE status Unit Tests passing

About this project

Generates .ts files for a CDS model to receive code completion in VS Code.

Exhaustive documentation can be found on CAPire.

Known Restrictions

Certain language features of CDS can not be represented in TypeScript. Trying to generate types for models using these features will therefore result in incorrect or broken TypeScript code.

Changing Types

While the following is valid CDS, there is no TypeScript equivalent that would allow the type of an inherited property to change (TS2416).

entity A {
  foo: Integer
};

entity B: A {
  foo: String
}

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright 2022-2022 SAP SE or an SAP affiliate company and cds-typer contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.