JavaScript and TypeScript

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, you should migrate it to v3 as the v2 client is no longer maintained.

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

The v3 client package has a new name, weaviate-client. Use npm to install the TypeScript client library package:

npm install weaviate-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:

import weaviate from "weaviate-client";

const weaviate = require("weaviate-client").default;

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

• Add "type": "module" to package.json
• Add the following code to tsconfig.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"]
}

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.

import weaviate, { WeaviateClient, vectors } from 'weaviate-client';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 dataasync 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 requestasync 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

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

Go to the GitHub releases page to see the history of the TypeScript client library releases and change logs.

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
• configure.vectorizer.none have been replaced with configure.vectors.selfProvided

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. If you are migrating from the JavaScript/TypeScript v2 client to the v3 client, see this migration guide.

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

The Weaviate API reference pages for search and REST may also be useful starting points.

Have a question or feedback? Here's how to reach us.