Skip to content

feat(types): improve search parameter types and add infix support #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(types): improve search parameter types and add infix support #248

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,20 @@ import type { SearchClient as AlgoliaSearchClient, CompositionClient } from "ins
type SearchClient = CompositionClient | AlgoliaSearchClient;

import type { ConfigurationOptions } from "typesense/lib/Typesense/Configuration";
import type { DocumentSchema, SearchParamsWithPreset } from "typesense/lib/Typesense/Documents";
import type { DocumentSchema, SearchParams, SearchParamsWithPreset } from "typesense/lib/Typesense/Documents";
import { OperationMode } from "typesense/lib/Typesense/Documents";
import { default as TypesenseSearchClient } from "typesense/lib/Typesense/SearchClient";
import { arrayableParams } from "typesense/lib/Typesense/Types";

interface BaseSearchParameters<T extends DocumentSchema, Infix extends string = string>
extends Partial<Omit<SearchParamsWithPreset<T, Infix>, "q" | "filter_by">> {
type SearchParamsWithoutArray<TDoc extends DocumentSchema, Infix extends string> = {
[K in keyof SearchParams<TDoc, Infix>]: K extends keyof typeof arrayableParams
? Exclude<SearchParams<TDoc, Infix>[K], any[]>
: SearchParams<TDoc, Infix>[K];
};

interface BaseSearchParameters<T extends DocumentSchema = DocumentSchema, Infix extends string = string>
extends Partial<Omit<SearchParamsWithoutArray<T, Infix>, "q" | "filter_by" | "infix">> {
preset?: string;
/**
* @deprecated Please use the snake_cased version of this parameter
*/
Expand Down Expand Up @@ -84,6 +93,8 @@ interface BaseSearchParameters<T extends DocumentSchema, Infix extends string =
* @deprecated Please use the snake_cased version of this parameter
*/
exhaustiveSearch?: boolean;

infix?: OperationMode | (string & {});
}

interface BaseAdapterOptions {
Expand Down
Loading