Lucenia Node.js client

• Welcome!
• Example use
  • Setup
• Sample code
• Project Resources
• Code of Conduct
• License
• Copyright

Welcome!

@lucenia/client is the official Node.js client for Lucenia. It is derived from the OpenSearch JavaScript client (itself a fork of elasticsearch-js) and is licensed under the Apache v2.0 License.

The API surface was originally generated from the OpenSearch API Spec. It has since been forked: api/ is now maintained by hand alongside the rest of the client, and evolves with Lucenia rather than tracking the upstream specification.

Example use

The Lucenia JavaScript client provides a safer and easier way to interact with your Lucenia cluster. Rather than using Lucenia from the browser and potentially exposing your data to the public, you can build a Lucenia client that takes care of sending requests to your cluster.

The client contains a library of APIs that let you perform different operations on your cluster and return a standard response body. The example here demonstrates some basic operations like creating an index, adding documents, and searching your data.

Setup

To add the client to your project, install it with npm:

npm i @lucenia/client

If you prefer to add the client manually or just want to examine the source code, see js-client on GitHub.

Then require the client:

const { Client } = require('@lucenia/client');

Sample code

Please see the USER_GUIDE for code snippets.

Project Resources

• Project Website
• Downloads
• Documentation
• Contributing to Lucenia
• Maintainer Responsibilities
• Release Management
• Admin Responsibilities
• Security
• NPM Page

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact [email protected] with any additional questions or comments.

License

This project is licensed under the Apache v2.0 License.

Copyright

Copyright Lucenia Contributors. See NOTICE for details.