Skip to content

fix: add ability to include/exclude fields for a single document #326

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
DDeenis wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: add ability to include/exclude fields for a single document #326

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
12 changes: 10 additions & 2 deletions src/Typesense/Document.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ import Documents, {
DocumentSchema,
DocumentWriteParameters,
} from "./Documents";
import { normalizeArrayableParams } from "./Utils";

export interface DocumentsRetrieveParameters {
include_fields?: string | string[];
exclude_fields?: string | string[];
}

export class Document<T extends DocumentSchema = object> {
constructor(
Expand All @@ -13,8 +19,10 @@ export class Document<T extends DocumentSchema = object> {
private apiCall: ApiCall
) {}

async retrieve(): Promise<T> {
return this.apiCall.get<T>(this.endpointPath());
async retrieve(options?: DocumentsRetrieveParameters): Promise<T> {
const queryParams = normalizeArrayableParams(options ?? {})

return this.apiCall.get<T>(this.endpointPath(), queryParams);
}

async delete(options?: DeleteQuery): Promise<T> {
Expand Down