/graal-types

Primary LanguageJavaScriptMIT LicenseMIT

Graal Types

Inspired by Definitely Typed

A repository for Java type definitions in TypeScript; made for Graal

Declaration Files

The declaration files within the types folder are purely type definitions with documentation. To learn more about declaration files, see TypeScript handbook.

You can install by doing one of the following (via npm/yarn):

npm install --save-dev @graal-types/{LIBRARY_HERE}
yarn add dev @graal-types/{LIBRARY_HERE}

Contributing

We use a modified tool called java-ts-bind created by bensku, which is found here. You'll need to clone the repo, compile it, copy the jar to ./types, visit the target folder (or create one for a new library), and configure the tsbindOptions field in a packageJson file (as needed).

Once configured, you can run:

cd types
java -jar java-ts-bind-all.jar --packageJson {FOLDER_HERE}

This should generate new typings. If they look correct, commit and create a PR.

Resources

Feel free to come join us in the Grakkit Discord in the #graal-types channel!