JS client for Typesense: https://github.com/typesense/typesense
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
dist
doc/examples
lib
src
test
.babelrc
.eslintignore
.eslintrc.json
.gitignore
LICENSE
README.md
gulpfile.babel.js
mocha.opts
package-lock.json
package.json

README.md

typesense-js NPM version CircleCI Greenkeeper badge

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 artificats - 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, please be sure to use the search-only-api-key instead of the master API key.

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 build and then npm publish

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/typesense/typesense-js.