typesense/src/Typesense/Stopwords.ts

Javascript Library for Typesense

import ApiCall from "./ApiCall";
import { StopwordSchema } from "./Stopword";

const RESOURCEPATH = "/stopwords";

export interface StopwordCreateSchema {
  stopwords: string[];
  locale?: string;
}

export interface StopwordsRetrieveSchema {
  stopwords: StopwordSchema[];
}

export default class Stopwords {
  constructor(private apiCall: ApiCall) {}

  async upsert(
    stopwordId: string,
    params: StopwordCreateSchema,
  ): Promise<StopwordSchema> {
    return this.apiCall.put<StopwordSchema>(
      this.endpointPath(stopwordId),
      params,
    );
  }

  async retrieve(): Promise<StopwordsRetrieveSchema> {
    return this.apiCall.get<StopwordsRetrieveSchema>(this.endpointPath());
  }

  private endpointPath(operation?: string): string {
    return `${Stopwords.RESOURCEPATH}${
      operation === undefined ? "" : "/" + encodeURIComponent(operation)
    }`;
  }

  static get RESOURCEPATH(): string {
    return RESOURCEPATH;
  }
}