typesense v1.8.2
typesense-js
Javascript client library for accessing the Typesense HTTP API. Follows the API spec here.
This library can be used both on the server-side and on the client-side. The library's source is in ES6 and during build time, we transpile it to ES5 and generate two artifacts - one that can be used on the server-side and another that uses Browserify and can be used on the client side.
Installation
Install via npm
$ npm install typesense
Include the minified JS file for use in the browser directly
<script src="dist/typesense.min.js"></script>
Usage
Read the documentation here: https://typesense.org/api/
Here are some examples that show you how the client works: doc/examples
Tests are also a good place to know how the the library works internally: test
Note: When using this library client-side (in a browser), please be sure to use the search-only-api-key
instead of the master
API key.
Compatibility
Typesense Server | typesense-js |
---|---|
<= v0.11 | <= v0.3.0 |
>= v0.12 | >= v0.4.0 |
Development
After checking out the repo, run npm install
to install dependencies. Then run npm test
to run the linter and tests.
To release a new version, run npm run build
and then npm publish
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/typesense/typesense-js.
16 days ago
16 days ago
17 days ago
22 days ago
23 days ago
30 days ago
1 month ago
1 month ago
1 month ago
2 months ago
3 months ago
3 months ago
3 months ago
4 months ago
5 months ago
5 months ago
6 months ago
11 months ago
8 months ago
8 months ago
9 months ago
7 months ago
8 months ago
11 months ago
11 months ago
7 months ago
9 months ago
9 months ago
10 months ago
12 months ago
12 months ago
9 months ago
10 months ago
10 months ago
10 months ago
9 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
1 year ago
1 year ago
2 years ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago