Typescript

$	npm install @boundaryml/baml

$	npx baml-cli generate

generator typescript {
  ...
  module_format "esm" // the default is "cjs" for CommonJS
}

{
  "scripts": {
    // Add a new command
    "baml-generate": "baml-cli generate",
    // Always call baml-generate on every build.
    "build": "npm run baml-generate && tsc --build",
  }
}

import { b } from "./baml_client"
import type { Resume } from "./baml_client/types"
async function Example(raw_resume: string): Promise<Resume> {
  // BAML's internal parser guarantees ExtractResume
  // to be always return a Resume type
  const response = await b.ExtractResume(raw_resume);
  return response;
}
async function ExampleStream(raw_resume: string): Promise<Resume> {
  const stream = b.stream.ExtractResume(raw_resume);
  for await (const msg of stream) {
    console.log(msg) // This will be a Partial<Resume> type
  }
  // This is guaranteed to be a Resume type.
  return await stream.getFinalResponse();
}

$	npm install @boundaryml/baml

$	npx baml-cli generate

generator typescript {
  ...
  module_format "esm" // the default is "cjs" for CommonJS
}

{
  "scripts": {
    // Add a new command
    "baml-generate": "baml-cli generate",
    // Always call baml-generate on every build.
    "build": "npm run baml-generate && tsc --build",
  }
}

import { b } from "./baml_client"
import type { Resume } from "./baml_client/types"
async function Example(raw_resume: string): Promise<Resume> {
  // BAML's internal parser guarantees ExtractResume
  // to be always return a Resume type
  const response = await b.ExtractResume(raw_resume);
  return response;
}
async function ExampleStream(raw_resume: string): Promise<Resume> {
  const stream = b.stream.ExtractResume(raw_resume);
  for await (const msg of stream) {
    console.log(msg) // This will be a Partial<Resume> type
  }
  // This is guaranteed to be a Resume type.
  return await stream.getFinalResponse();
}

1	generator typescript {
2	...
3	module_format "esm" // the default is "cjs" for CommonJS
4	}

1	{
2	"scripts": {
3	// Add a new command
4	"baml-generate": "baml-cli generate",
5	// Always call baml-generate on every build.
6	"build": "npm run baml-generate && tsc --build",
7	}
8	}

1	import { b } from "./baml_client"
2	import type { Resume } from "./baml_client/types"
3
4	async function Example(raw_resume: string): Promise<Resume> {
5	// BAML's internal parser guarantees ExtractResume
6	// to be always return a Resume type
7	const response = await b.ExtractResume(raw_resume);
8	return response;
9	}
10
11	async function ExampleStream(raw_resume: string): Promise<Resume> {
12	const stream = b.stream.ExtractResume(raw_resume);
13	for await (const msg of stream) {
14	console.log(msg) // This will be a Partial<Resume> type
15	}
16
17	// This is guaranteed to be a Resume type.
18	return await stream.getFinalResponse();
19	}

Install BAML VSCode/Cursor Extension

Install BAML

npm

pnpm

yarn

bun

deno

Add BAML to your existing project

npm

pnpm

yarn

bun

deno

Generate the baml_client typescript package from .baml files

npm

pnpm

yarn

bun

deno

Use a BAML function in Typescript!

Async

Sync

Install BAML VSCode/Cursor Extension

Install BAML

npm

pnpm

yarn

bun

deno

Add BAML to your existing project

npm

pnpm

yarn

bun

deno

Generate the baml_client typescript package from .baml files

npm

pnpm

yarn

bun

deno

Use a BAML function in Typescript!

Async

Sync

Generate the `baml_client` typescript package from `.baml` files

Generate the `baml_client` typescript package from `.baml` files