typesense / typesense/typesense-js

Add q parameter to export method

Open
#148 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
569
Forks
99
Avg merge
5h 6m
Merged PRs (30d)
2

Description

Description

Today, the export method allows filter_by parameter. It should be great if the export method also allow the q (query) parameter.

Expected Behavior

client.collections('companies').documents().export({ q, filter_by })

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the client.collections('companies').documents().export({ q, filter_by }) entry point and locate its implementation and existing export coverage. Done means the export method accepts q alongside filter_by and the relevant tests confirm the expected request behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.