Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
typesense
Advanced tools
Readme
Javascript client library for accessing the Typesense HTTP API.
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
Note: @babel/runtime
is very a common dependency among many JS libraries. So instead of each library adding it as a dependency independently (which will cause multiple instances of @babel/runtime
to be installed increasing bundle size), Babel's recommendation is that the libraries ask users to install it once as a direct dependency, so there's only one copy of @babel/runtime
for the entire project. In some cases, your JS framework might already include @babel/runtime
as a dependency.
<script src="dist/typesense.min.js"></script>
or via jsDelivr
<script src="https://cdn.jsdelivr.net/npm/typesense@1/dist/typesense.min.js"></script>
Read the documentation here for detailed examples: https://typesense.org/docs/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.
See Configuration.ts for a list of all client configuration options.
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.
If you use Firebase, we have a Firebase extension (that uses typesense-js behind the scenes) to automatically push your Firestore data to Typesense. 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.
This table refers to server=>client compatibility. Newer versions of the client library maintain backwards compatibility with older versions of the server library.
Typesense Server | typesense-js |
---|---|
>= v0.26.0.rc38 | >= v1.8.0 |
>= v0.25.0 | >= v1.7.0 |
>= v0.24.0 | >= v1.5.0 |
>= v0.23.0 | >= v1.3.0 |
>= v0.21.0 | >= v0.14.0 |
>= 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 typesense receives a total of 90,367 weekly downloads. As such, typesense popularity was classified as popular.
We found that typesense demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers 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
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.