typesense/src/Typesense/Operations.ts

Javascript Library for Typesense

import ApiCall from "./ApiCall";

const RESOURCEPATH = "/operations";

export interface SchemaChangeStatus {
  collection: string;
  validated_docs: number;
  altered_docs: number;
}

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

  async perform(
    operationName:
      | "vote"
      | "snapshot"
      | "cache/clear"
      // eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Can't use `object` here, it needs to intersect with `{}`
      | (string & {}),
    queryParameters: Record<string, any> = {},
  ): Promise<any> {
    return this.apiCall.post(
      `${RESOURCEPATH}/${operationName}`,
      {},
      queryParameters,
    );
  }

  async getSchemaChanges(): Promise<SchemaChangeStatus[]> {
    return this.apiCall.get<SchemaChangeStatus[]>(
      `${RESOURCEPATH}/schema_changes`,
    );
  }
}