Change name of class

.husky/pre-commit

@@ -1 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
 bun run fmt && bun run test

index.ts

@@ -33,7 +33,7 @@ export type VectorConfig = {
 /**
  * Serverless vector client for upstash.
  */
-export class Vector extends core.Vector {
+export class Index extends core.Index {
   /**
    * Create a new vector client by providing the url and token
    *
@@ -105,7 +105,7 @@ export class Vector extends core.Vector {
    * This tries to load `UPSTASH_VECTOR_REST_URL` and `UPSTASH_VECTOR_REST_TOKEN` from
    * your environment using `process.env`.
    */
-  static fromEnv(config?: Omit<VectorConfig, "url" | "token">): Vector {
+  static fromEnv(config?: Omit<VectorConfig, "url" | "token">): Index {
     const url = process?.env.UPSTASH_VECTOR_REST_URL;
     if (!url) {
       throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");
@@ -114,6 +114,6 @@ export class Vector extends core.Vector {
     if (!token) {
       throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");
     }
-    return new Vector({ ...config, url, token });
+    return new Index({ ...config, url, token });
   }
 }

package.json

@@ -19,7 +19,7 @@
     "url": "https://github.com/upstash/vector/issues"
   },
   "scripts": {
-    "test": "bun test src --coverage --bail",
+    "test": "bun test src --coverage --bail --coverageSkipTestFiles=[test-utils.ts]",
     "fmt": "bunx biome check --apply ./src",
     "build": "tsup",
     "prepare": "husky install"

src/vector.ts

@@ -9,17 +9,17 @@ export type CommandArgs<TCommand extends new (_args: any) => any> =
 /**
  * Serverless vector client for upstash vector db.
  */
-export class Vector {
+export class Index {
   protected client: Requester;
 
   /**
    * Create a new vector db client
    *
    * @example
    * ```typescript
-   * const redis = new Vector({
-   *  url: "<UPSTASH_REDIS_REST_URL>",
-   *  token: "<UPSTASH_REDIS_REST_TOKEN>",
+   * const index = new Index({
+   *  url: "<UPSTASH_VECTOR_REST_URL>",
+   *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
    * });
    * ```
    */