For smooth auto-completion, parameter hints, and type safety in modern IDEs (VS Code, Cursor, WebStorm), Beejs includes full official TypeScript type definitions (types/beejs.d.ts).

1. Exporting Definitions (`bee types`)

Definitions are embedded directly inside the compiled binary. Use bee types to export them instantly:

code

# Print definitions directly to stdout
$ bee types

# Export to your project root
$ bee types -o beejs.d.ts

Console output:

code

📄 TypeScript definition written to: beejs.d.ts

2. Project Configuration

Add the exported definition file to your tsconfig.json:

code

{
  "compilerOptions": {
    "target": "ESNext",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true,
    "skipLibCheck": true
  },
  "include": ["src/**/*", "beejs.d.ts"]
}

3. Covered Type APIs

The declaration file provides full typings for Beejs infrastructure:

3.1 `bee:ai` Module

Typed tensor math and local LLM inference engines:

code

import { Tensor, LLM, AgentPipeline } from "bee:ai";

const a = new Tensor([1.0, 2.0, 3.0], [1, 3]);
const sim: number = a.cosineSimilarity(new Tensor([2.0, 4.0, 6.0], [1, 3]));

const llm = new LLM({ model: "llama-3.2-1b" });

3.2 `bee:bench` Module

Microbenchmark runner signatures:

code

import { bench } from "bee:bench";

bench("Hash Computation", () => {
  // benchmark body
});

3.3 Global & Web API Extensions

Adds complete typings for Request, Response, fetch, Worker, WebSocket, BroadcastChannel, and process.dlopen.

Official TypeScript Type Definitions (TypeScript Types)

1. Exporting Definitions (bee types)

2. Project Configuration

3. Covered Type APIs

3.1 bee:ai Module

3.2 bee:bench Module

3.3 Global & Web API Extensions

1. Exporting Definitions (`bee types`)

3.1 `bee:ai` Module

3.2 `bee:bench` Module