Class Indexes

waitUntilReady

• waitUntilReady(
      parameters: {
          index: string;
          interval?: number;
          organization: string;
          signal?: AbortSignal;
          timeout?: number;
      },
  ): Promise<Index>

  Wait until the index is ready to store and search documents, checking every interval milliseconds (default 500) for at most timeout milliseconds (default 60,000), and return it.

  An index that is being deleted, or that does not become ready in time, throws GrepvineError.

  await client.indexes.create({ organization: "acme", name: "docs" });
  const index = await client.indexes.waitUntilReady({ organization: "acme", index: "docs" });
  Copy

  Parameters

  • parameters: {
        index: string;
        interval?: number;
        organization: string;
        signal?: AbortSignal;
        timeout?: number;
    }

  Returns Promise<Index>