typesense / typesense/typesense-js
[Feature] Create small .js file conaining ONLY search-related functionality (for use in browser)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 569
- Forks
- 99
- Avg merge
- 5h 6m
- Merged PRs (30d)
- 2
Description
Description
Having full functionality of Typeset API in one file (typesense.min.js, about 95 kB) is great - when you need this functionality. But when your code works in web browser - all you do is something like this:
typesense = new Typesense.SearchClient(...)
...
typesense.collections('test').documents().search({...}).then(
function (searchResults){
...
searchResults.hits
...
}
I mean - the end-user is not creating collections/documents/synonyms/aliases...
The end-user just searching.
Expected Behavior
There is a need for something like typesense-search.js.
It should contains Typesense.SearchClient and ... basically that's it.
Should have enough functionality to do search in browser.
Should be... I would say... less than 30 kB
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the current typesense.min.js bundle and the Typesense.SearchClient entry point to identify the search-only dependency surface. A complete change would provide a separate typesense-search.js browser bundle containing the required search functionality and keep it below 30 kB; no specific test file is mentioned.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- frontend, search, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100