java-ts-definition-generator v1.2.0

Java typescript definition generator

This is the typescript definition generator for the java-bridge package. It generates typescript definitions for java classes and interfaces.

It can either be invoked from the command line or used as a library.

Installation

Note: You need to install java-bridge separately

npm install -g java-ts-definition-generator java-bridge

Command line usage

java-ts-gen <output> <classnames..>

Positionals:
  classnames  The fully qualified class name(s) to convert              [string]
  output      The output file                                           [string]

Options:
  --help             Show help                                         [boolean]
  --version          Show version number                               [boolean]
  --classpath, --cp  The classpath to use                               [string]
  --syncSuffix       The sync suffix                                    [string]
  --asyncSuffix      The async suffix                                   [string]
  --customInspect    Whether to enable the 'customInspect' option      [boolean]

Notes

• The classpath argument can be supplied multiple times to add multiple jars to the classpath
• Multiple class names can be supplied to generate definitions for multiple classes
• The generated typescript files will automatically import all classes once the module is loaded.
• If a glob pattern, e.g. com.github.*, is supplied for the class names, all supplied jars will be searched against that glob pattern. Definitions for all matching classes will be generated. This does not work for classes supplied by the JVM.

Examples

Generate definitions for a single class

Generate definitions for the java.lang.String class and all its referenced classes and save them to ./project:

java-ts-gen ./project java.lang.String

This will create a directory called java containing the definitions for the java.lang.String class and all its dependencies all inside subdirectories. The java.lang.String class will be saved to ./project/java/lang/String.ts. Thus, the folder structure of project will look something like this:

.
├── ...
├── java
│   ├── lang
│   │   ├── String.ts
│   │   ├── Object.ts
│   │   └── ...
│   ├── util
│   │   └── ...
│   └── ...
└── ...

Generate definitions for multiple classes

Generate definitions for the java.lang.String and java.util.ArrayList classes and all of their dependencies and save them to ./project:

java-ts-gen ./project java.lang.String java.util.ArrayList

Generate definitions for all classes inside a JAR

Generate definitions for all classes inside the package com.github and save them to ./project:

java-ts-gen --cp /path/to/my.jar ./project com.github.*

Library usage

import { TypescriptDefinitionGenerator } from 'java-ts-definition-generator';

const generator = new TypescriptDefinitionGenerator([
    'java.lang.String',
    'java.util.List',
]);
// Generate the typescript definitions
await generator.createModuleDeclarations();

// Save the definitions to a directory
await TypescriptDefinitionGenerator.save('./project');

Available generators

The java declaration tree can be generated using two generators:

• JavaDefinitionGenerator: This generator is the fastest, as it is written in Java. Requires Java 11 or higher.
• TsDefinitionGenerator: This one is slower than the JavaDefinitionGenerator as it is written in Typescript, but it works with any Java version.

The best generator is automatically picked when instantiating the TypescriptDefinitionGenerator class. If you still want to choose the generator yourself, you can pass an instance of the JavaDefinitionGenerator or TsDefinitionGenerator into the constructor of the TypescriptDefinitionGenerator.