@minecraft-types/java.base

TypeScript type definitions for the JVM java.base module (JDK 21.0.8).

Install

Install from npm or pnpm:

npm install @minecraft-types/java.base
# or
pnpm add @minecraft-types/java.base

Setup

In your tsconfig.json, add the following to the compilerOptions section:

{
  "compilerOptions": {
    "types": [
      "@minecraft-types/java.base"
    ]
  }
}

Note: adding the types array explicitly tells TypeScript which global type packages to include. When you set compilerOptions.types it will only include the packages listed there and will not automatically include other @types/* packages (for example node). If you need other ambient types, add them to the array as well or consider using typeRoots or a project global.d.ts instead.

Using the types and handling globals

By default, this will expose the types under the Packages namespace (ex. Packages.java.io.BufferedInputStream).

If you work in an environment where the global namespace is polluted differently with Java types, you can re-namespace the types by creating a global.d.ts file in your project with the following content:

// global.d.ts
declare global {
  const java: typeof Packages.java;
  // Add other root namespaces as needed (e.g., javax, com, org, etc.)
  // const com: typeof Packages.com;

  // If your environment exposes something other than 'Packages', you can alias it here
  // const SomeOtherPackages: typeof Packages;
}

export {}; // keep file a module so TS merges properly

If instead, you'd prefer to only pollute the global namespace within that file, you can add the following to your typescript files:

declare const java: typeof Packages.java;
// Add other root namespaces as needed (e.g., javax, com, org, etc.)
// declare const com: typeof Packages.com;

// If your environment exposes something other than 'Packages', you can alias it here
// declare const SomeOtherPackages: typeof Packages;

Examples

• Referencing a Java type directly from the ambient Packages types:

// Uses the package name as exposed by the types
type BIS = Packages.java.io.BufferedInputStream;

declare const inStream: BIS;

• Using the java alias from the global.d.ts example:

const s: string = java.lang.String.valueOf(123);

License

CC0-1.0