Socket
Socket
Sign inDemoInstall

@ziao/typesense

Package Overview
Dependencies
97
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ziao/typesense

Javascript Library for Typesense


Version published
Maintainers
1
0

Weekly downloads

Readme

Source

typesense-js NPM version CircleCI downloads

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 --save typesense

Install peer dependencies:

npm install --save @babel/runtime
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/

Tests are also a good place to know how the library works internally: test

Note: When using this library in a browser, please be sure to use an API Key that only allows search operations instead of the master API key. See doc/examples/server/keys.js for an example of how to generate a search only API key.

Examples

Here are some examples with inline comments that walk you through how to use the client: doc/examples

To run the examples, from the repo root:

npm run typesenseServer
node doc/examples/server/bulkImport.js

GatsbyJS Integration

If you use GatsbyJS for a framework, we have a plugin (that uses typesense-js behind the scenes) to automatically push your site data to Typesense when you build your site. Learn more here.

Building UI components

Checkout the Typesense-InstantSearch.js (which uses typesense-js) for UI components you can use to quickly build powerful instant search experiences.

Compatibility

Typesense Servertypesense-js
>= v0.20.0>= v0.12.0
>= v0.19.0>= v0.11.0
>= v0.18.0>= v0.10.0
>= v0.17.0>= v0.9.0
>= v0.16.0>= v0.8.0
>= v0.15.0>= v0.7.0
>= v0.12.1>= v0.5.0
>= v0.12.0>= v0.4.7
<= v0.11<= v0.3.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, we use the np package:

$ npm install --global np
$ np

# Follow instructions that np shows you

Contributing

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

Keywords

FAQs

Last updated on 13 Jun 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc