Class Search

query

• query<ThrowOnError extends boolean = true>(
      parameters: {
          amount?: number;
          case_sensitive?: boolean;
          filter?: string;
          index: string;
          lines_after?: number;
          lines_before?: number;
          mode?: "regex" | "literal";
          multiline?: boolean;
          organization: string;
          page?: string;
          pattern: string;
          whole_word?: boolean;
      },
      options?: Options<never, ThrowOnError, unknown>,
  ): RequestResult<
      QueryIndexResponses,
      QueryIndexErrors,
      ThrowOnError,
      "data",
  >

  Search an index

  Type Parameters

  • ThrowOnError extends boolean = true

  Parameters

  • parameters: {
        amount?: number;
        case_sensitive?: boolean;
        filter?: string;
        index: string;
        lines_after?: number;
        lines_before?: number;
        mode?: "regex" | "literal";
        multiline?: boolean;
        organization: string;
        page?: string;
        pattern: string;
        whole_word?: boolean;
    }
  • Optionaloptions: Options<never, ThrowOnError, unknown>

  Returns RequestResult<QueryIndexResponses, QueryIndexErrors, ThrowOnError, "data">