---
title: "JavaScript and TypeScript"
description: "Official TypeScript/JavaScript client library documentation for integrating Weaviate with web applications."
url: https://docs.weaviate.io/weaviate/client-libraries/typescript
---

# JavaScript and TypeScript

> [!NOTE]
>
> **JavaScript/TypeScript client (SDK)**
>
> The latest TypeScript client is version `v3.15.1`.
>
> [weaviate/typescript-client](https://github.com/weaviate/typescript-client)[Reference manual](https://weaviate.github.io/typescript-client/index.html)

The TypeScript client supports code that is written in TypeScript or JavaScript.

The **v3 client** is the current TypeScript client. If you have code written for the [v2 client](https://docs.weaviate.io/weaviate/client-libraries/typescript#javascripttypescript-client-v2-deprecation), you should migrate it to v3 as the v2 client is no longer maintained.

> [!NOTE]
>
> For Node.js, use `@weaviate/node`. For browsers and edge runtimes, use the [web client](https://docs.weaviate.io/weaviate/client-libraries/typescript/web-client).

## Installation

This section details how to install and configure the v3 TypeScript client.

#### Install the package

Use [npm](https://www.npmjs.com/) to install the `@weaviate/node` package. It needs Node.js 22 or later.

```bash
npm install @weaviate/node
```

The client ships as these packages:

| Package | Use it for |
| - | - |
| `@weaviate/node` | Node.js applications. |
| `@weaviate/web` | Browsers and edge runtimes. See [Web client](https://docs.weaviate.io/weaviate/client-libraries/typescript/web-client). |
| `@weaviate/core` | The shared base of both clients. Apps do not install it. |
| `weaviate-client` | Existing projects. The previous package name, still released for a transition period. |

Move existing projects to `@weaviate/node`. The v2 compatibility export is only in `weaviate-client`.

The Query Agent client is published as [`@weaviate/agents`](https://docs.weaviate.io/query-agent/clients/typescript) and works with `@weaviate/node` and `@weaviate/web`.

#### Import the Client

The v3 client uses `ES Modules`. Most of the sample code in the documentation also uses the `ES Module` style.

If your code requires `CommonJS` compatibility, use the `CommonJS` import style:

**ES Modules**

```ts
import weaviate from "@weaviate/node";
```

**CommonJS**

```ts
const weaviate = require("@weaviate/node").default;
```

#### TypeScript setup

Edit your project's configuration files to make these changes:

- Add `"type": "module"` to `package.json`
- Add the following code to [`tsconfig.json`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)

**tsconfig.json file**

```json
{
  "compilerOptions": {
    "target": "ESNext",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "allowSyntheticDefaultImports": true,
    "strict": true
  },
  "include": ["src/index.ts"] // this compiles only src/.index.ts, to compile all .ts files, use ["*.ts"]
}
```

## Get started

> [!TIP]
>
> **Prerequisites**
>
> If you haven't yet, we recommend going through the [**Quickstart tutorial**](https://docs.weaviate.io/weaviate/quickstart) first to get the most out of this section.

The following code demonstrates how to:

1. Connect to a local Weaviate instance.
2. Create a new collection.
3. Populate the database using batch import and vectorize the data.
4. Perform a vector search.

```ts
import weaviate, { WeaviateClient, vectors } from '@weaviate/node';

const client: WeaviateClient = await weaviate.connectToLocal();

await client.collections.create({
    name: 'Question',
    vectorizers: vectors.text2VecOllama({    // Configure the Ollama embedding integration
        apiEndpoint: 'http://ollama:11434',  // If using Docker you might need: http://host.docker.internal:11434
        model: 'nomic-embed-text',           // The model to use
    }),
});

// Load data
async function getJsonData() {
    const file = await fetch(
        'https://raw.githubusercontent.com/weaviate-tutorials/quickstart/main/data/jeopardy_tiny.json'
    );
    return file.json();
}

// Note: The TS client does not have a `batch` method yet
// We use `insertMany` instead, which sends all of the data in one request
async function importQuestions() {
    const questions = client.collections.use('Question');
    const data = await getJsonData();
    const result = await questions.data.insertMany(data);
    console.log('Insertion response: ', result);
}

await importQuestions();

const questions = client.collections.use('Question');

const result = await questions.query.nearText('biology', {
    limit: 2,
});

result.objects.forEach((item) => {
    console.log(JSON.stringify(item.properties, null, 2));
});

client.close(); // Close the client connection
```

## Asynchronous usage

All client v3 methods, with the exception of `collection.use()`, use ES6 Promises with asynchronous code. This means you have to use `.then()` after function calls, or wrap your code `async/await` blocks.

When there is an asynchronous code error, a promise returns the specific error message. If you use `async` and `await`, a rejected promises acts like a thrown exception

## Web client (`@weaviate/web`)

`@weaviate/web` has the same API as `@weaviate/node` and connects over gRPC-Web on the HTTP(S) port.

For install steps and browser notes, see [Web client](https://docs.weaviate.io/weaviate/client-libraries/typescript/web-client).

## Releases

Go to the [GitHub releases page](https://github.com/weaviate/typescript-client/releases) to see the history of the TypeScript client library releases and change logs.

**Click here for a table of Weaviate and corresponding client versions**

This table lists recent Weaviate Database versions and corresponding client library versions.

| Weaviate Database ([GitHub](https://github.com/weaviate/weaviate/releases)) | First release date | Python ([GitHub](https://github.com/weaviate/weaviate-python-client/releases)) | TypeScript/ JavaScript ([GitHub](https://github.com/weaviate/typescript-client/releases)) | Go ([GitHub](https://github.com/weaviate/weaviate-go-client/releases)) | Java ([GitHub](https://github.com/weaviate/java-client/releases)) | C# ([GitHub](https://github.com/weaviate/csharp-client/releases)) |
| - | - | - | - | - | - | - |
| [1.40.x](https://github.com/weaviate/weaviate/releases/tag/v1.40.0) | 2026-10-07 | [4.24.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.24.0) | [3.15.x](https://github.com/weaviate/typescript-client/releases/tag/v3.15.1) | [6.0.0](https://github.com/weaviate/weaviate-go-client/releases/tag/v6.0.0) | [6.3.2](https://github.com/weaviate/java-client/releases/tag/6.3.2) | - |
| [1.39.x](https://github.com/weaviate/weaviate/releases/tag/v1.39.0) | 2026-08-04 | [4.23.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.23.0) | [3.15.x](https://github.com/weaviate/typescript-client/releases/tag/v3.15.0) | - | [6.3.1](https://github.com/weaviate/java-client/releases/tag/6.3.1) | [1.2.0](https://github.com/weaviate/csharp-client/releases/tag/1.2.0) |
| [1.38.x](https://github.com/weaviate/weaviate/releases/tag/v1.38.0) | 2026-06-05 | [4.22.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.22.0) | [3.14.x](https://github.com/weaviate/typescript-client/releases/tag/v3.14.0) | - | [6.3.0](https://github.com/weaviate/java-client/releases/tag/6.3.0) | [1.2.0](https://github.com/weaviate/csharp-client/releases/tag/1.2.0) |
| [1.37.x](https://github.com/weaviate/weaviate/releases/tag/v1.37.0) | 2026-04-16 | [4.21.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.21.0) | [3.13.x](https://github.com/weaviate/typescript-client/releases/tag/v3.13.0) | [5.7.3](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.7.3) | [6.2.0](https://github.com/weaviate/java-client/releases/tag/6.2.0) | [1.1.1](https://github.com/weaviate/csharp-client/releases/tag/1.1.1) |
| [1.36.x](https://github.com/weaviate/weaviate/releases/tag/v1.36.0) | 2026-02-24 | [4.20.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.20.0) | [3.12.x](https://github.com/weaviate/typescript-client/releases/tag/v3.12.0) | [5.7.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.7.0) | [6.1.0](https://github.com/weaviate/java-client/releases/tag/6.1.0) | [1.0.1](https://github.com/weaviate/csharp-client/releases/tag/1.0.1) |

**Older releases**

| Weaviate Database ([GitHub](https://github.com/weaviate/weaviate/releases)) | First release date | Python ([GitHub](https://github.com/weaviate/weaviate-python-client/releases)) | TypeScript/ JavaScript ([GitHub](https://github.com/weaviate/typescript-client/releases)) | Go ([GitHub](https://github.com/weaviate/weaviate-go-client/releases)) | Java ([GitHub](https://github.com/weaviate/java-client/releases)) | C# ([GitHub](https://github.com/weaviate/csharp-client/releases)) |
| - | - | - | - | - | - | - |
| [1.35.x](https://github.com/weaviate/weaviate/releases/tag/v1.35.0) | 2025-12-17 | [4.19.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.19.0) | [3.11.x](https://github.com/weaviate/typescript-client/releases/tag/v3.11.0) | [5.6.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.6.0) | [6.0.0](https://github.com/weaviate/java-client/releases/tag/6.0.0) | [1.0.0](https://github.com/weaviate/csharp-client/releases/tag/1.0.0) |
| [1.34.x](https://github.com/weaviate/weaviate/releases/tag/v1.34.0) | 2025-11-05 | [4.18.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.18.0) | [3.10.x](https://github.com/weaviate/typescript-client/releases/tag/v3.10.0) | [5.6.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.6.0) | [6.0.0](https://github.com/weaviate/java-client/releases/tag/6.0.0) | - |
| [1.33.x](https://github.com/weaviate/weaviate/releases/tag/v1.33.0) | 2025-09-25 | [4.17.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.17.0) | [3.9.x](https://github.com/weaviate/typescript-client/releases/tag/v3.9.0) | [5.5.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.5.0) | [5.5.x](https://github.com/weaviate/java-client/releases/tag/5.5.0) | - |
| [1.32.x](https://github.com/weaviate/weaviate/releases/tag/v1.32.0) | 2025-07-14 | [4.16.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.16.0) | [3.8.x](https://github.com/weaviate/typescript-client/releases/tag/v3.8.0) | [5.3.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.3.0) | [5.4.x](https://github.com/weaviate/java-client/releases/tag/5.4.0) | - |
| [1.31.x](https://github.com/weaviate/weaviate/releases/tag/v1.31.0) | 2025-05-30 | [4.15.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.15.0) | [3.6.x](https://github.com/weaviate/typescript-client/releases/tag/v3.6.0) | [5.2.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.2.0) | [5.3.x](https://github.com/weaviate/java-client/releases/tag/5.3.0) | - |
| [1.30.x](https://github.com/weaviate/weaviate/releases/tag/v1.30.0) | 2025-04-03 | [4.12.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.12.0) | [3.5.x](https://github.com/weaviate/typescript-client/releases/tag/v3.5.0) | [5.1.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.1.0) | [5.2.x](https://github.com/weaviate/java-client/releases/tag/5.2.0) | - |
| [1.29.x](https://github.com/weaviate/weaviate/releases/tag/v1.29.0) | 2025-02-17 | [4.11.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.11.0) | [3.4.x](https://github.com/weaviate/typescript-client/releases/tag/v3.4.0) | [5.0.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.0.0) | [5.1.x](https://github.com/weaviate/java-client/releases/tag/5.1.0) | - |
| [1.28.x](https://github.com/weaviate/weaviate/releases/tag/v1.28.0) | 2024-12-11 | [4.10.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.10.0) | [3.3.x](https://github.com/weaviate/typescript-client/releases/tag/v3.3.0) | [4.16.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.16.0) | [5.0.x](https://github.com/weaviate/java-client/releases/tag/5.0.0) | - |
| [1.27.x](https://github.com/weaviate/weaviate/releases/tag/v1.27.0) | 2024-10-16 | [4.9.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.9.0) | [3.2.x](https://github.com/weaviate/typescript-client/releases/tag/v3.2.0) | [4.16.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.16.0) | [5.0.x](https://github.com/weaviate/java-client/releases/tag/5.0.0) [4.9.x](https://github.com/weaviate/java-client/releases/tag/4.9.0) | - |
| [1.26.x](https://github.com/weaviate/weaviate/releases/tag/v1.26.0) | 2024-07-22 | [4.7.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.7.0) | [3.1.x](https://github.com/weaviate/typescript-client/releases/tag/v3.1.0) | [4.15.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.15.0) | [4.8.x](https://github.com/weaviate/java-client/releases/tag/4.8.0) | - |
| [1.25.x](https://github.com/weaviate/weaviate/releases/tag/v1.25.0) | 2024-05-10 | [4.6.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.6.0) | [2.1.x](https://github.com/weaviate/typescript-client/releases/tag/v2.1.0) | [4.13.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.13.0) | [4.6.x](https://github.com/weaviate/java-client/releases/tag/4.6.0) | - |
| [1.24.x](https://github.com/weaviate/weaviate/releases/tag/v1.24.0) | 2024-02-27 | [4.5.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.5.0) | [2.0.x](https://github.com/weaviate/typescript-client/releases/tag/v2.0.0) | [4.10.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.10.0) | [4.4.x](https://github.com/weaviate/java-client/releases/tag/4.4.0) | - |
| 1.23.x | 2023-12-18 | 3.26.x | 1.5.x | 4.10.x | 4.4.x | - |
| 1.22.x | 2023-10-27 | 3.25.x | 1.5.x | 4.10.x | 4.3.x | - |
| 1.21.x | 2023-08-17 | 3.22.x | 1.4.x | 4.9.x | 4.2.x | - |
| 1.20.x | 2023-07-06 | 3.22.x | 1.1.x | 4.7.x | 4.2.x | - |
| 1.19.x | 2023-05-04 | 3.17.x | 1.1.x[1](https://docs.weaviate.io/weaviate/client-libraries/typescript#typescript-client-change) | 4.7.x | 4.0.x | - |
| 1.18.x | 2023-03-07 | 3.13.x | 2.14.x | 4.6.x | 3.6.x | - |
| 1.17.x | 2022-12-20 | 3.9.x | 2.14.x | 4.5.x | 3.5.x | - |
| 1.16.x | 2022-10-31 | 3.8.x | 2.13.x | 4.4.x | 3.4.x | - |
| 1.15.x | 2022-09-07 | 3.6.x | 2.12.x | 4.3.x | 3.3.x | - |
| 1.14.x | 2022-07-07 | 3.6.x | 2.11.x | 4.2.x | 3.2.x | - |
| 1.13.x | 2022-05-03 | 3.4.x | 2.9.x | 4.0.x | 2.4.x | - |
| 1.12.x | 2022-04-05 | 3.4.x | 2.8.x | 3.0.x | 2.3.x | - |
| 1.11.x | 2022-03-14 | 3.2.x | 2.7.x | 2.6.x | 2.3.x | - |
| 1.10.x | 2022-01-27 | 3.1.x | 2.5.x | 2.4.x | 2.1.x | - |
| 1.9.x | 2021-12-10 | 3.1.x | 2.4.x | 2.4.x | 2.1.x | - |
| 1.8.x | 2021-11-30 | 3.1.x | 2.4.x | 2.3.x | 1.1.x | - |
| 1.7.x | 2021-09-01 | 3.1.x | 2.4.x | 2.3.x | 1.1.x | - |
| 1.6.x | 2021-08-11 | 2.4.x | 2.3.x | 2.2.x | 1.0.x | - |
| 1.5.x | 2021-07-13 | 2.2.x | 2.1.x | 2.1.x | 1.0.x | - |
| 1.4.x | 2021-06-09 | 2.2.x | 2.1.x | 2.1.x | 1.0.x | - |
| 1.3.x | 2021-04-23 | 2.2.x | 2.1.x | 2.1.x | 1.0.x | - |
| 1.2.x | 2021-03-15 | 2.2.x | 2.0.x | 1.1.x | - | - |
| 1.1.x | 2021-02-10 | 2.1.x | - | - | - | - |
| 1.0.x | 2021-01-14 | 2.0.x | - | - | - | - |

#### TypeScript client change

The [TypeScript client](https://github.com/weaviate/typescript-client) replaced the [JavaScript client](https://github.com/weaviate/weaviate-javascript-client) on 2023-03-17.

#### Vectorizer API changes `v3.8.0`

Starting with the Weaviate JS/TS client `v3.8.0`, there are multiple changes to the vectorizer configuration API when creating collections:

- `configure.vectorizer` has been replaced with `configure.vectors`
- `configure.multiVectors` has been added to enable users work with [Multi-vectors](https://docs.weaviate.io/weaviate/manage-collections/vector-config#define-multi-vector-embeddings-eg-colbert-colpali)
- `configure.vectorizer.none` have been replaced with `configure.vectors.selfProvided`

#### JavaScript/TypeScript client `v2` deprecation

The Weaviate JavaScript/TypeScript client `v2` has been deprecated and should no longer be used. If you need documentation for the `v2` client, see the [documentation archive](https://archive.docs.weaviate.io/weaviate/client-libraries/typescript/typescript-v2). If you are migrating from the JavaScript/TypeScript `v2` client to the `v3` client, see this [migration guide](https://archive.docs.weaviate.io/weaviate/client-libraries/typescript/v2_v3_migration).

## Code examples & further resources

Usage information for various operations and features can be found throughout the Weaviate documentation.



[How-to: Configure Weaviate](https://docs.weaviate.io/weaviate/configuration): Configure compression, backups, authentication, authorization, data replication and more.

[How-to: Manage collections](https://docs.weaviate.io/weaviate/manage-collections): Manage collections (CRUD), configure vectorizers and index parameters, set up multi-tenancy, and perform migrations.

[How-to: Manage objects](https://docs.weaviate.io/weaviate/manage-objects): Adding new objects, fetching existing ones, modifying them, and removing them from collections.

[How-to: Query & search](https://docs.weaviate.io/weaviate/search): From basic vector and hybrid searches to specialized image queries and performing data aggregations.



The Weaviate API reference pages for [search](https://docs.weaviate.io/weaviate/api) and [REST](https://docs.weaviate.io/weaviate/api/rest) may also be useful starting points.
