Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@ziao/typesense
Advanced tools
Readme
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.
npm install --save typesense
Install peer dependencies:
npm install --save @babel/runtime
<script src="dist/typesense.min.js"></script>
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.
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
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.
Checkout the Typesense-InstantSearch.js (which uses typesense-js) for UI components you can use to quickly build powerful instant search experiences.
Typesense Server | typesense-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 |
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
Bug reports and pull requests are welcome on GitHub at https://github.com/typesense/typesense-js.
FAQs
Javascript Library for Typesense
The npm package @ziao/typesense receives a total of 1 weekly downloads. As such, @ziao/typesense popularity was classified as not popular.
We found that @ziao/typesense demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.