Skip to content

opensearch-project/opensearch-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

nhtruongAMoo-Mikiopensearch-trigger-bot[bot]github-actions[bot]
Jul 18, 2023
f9a2fe1 · Jul 18, 2023
Dec 16, 2022
Jul 18, 2023
Feb 8, 2023
Apr 13, 2023
Nov 9, 2022
Jul 18, 2023
Sep 30, 2022
Jul 18, 2023
Aug 20, 2021
May 24, 2022
Dec 27, 2022
Jan 23, 2023
Oct 6, 2021
May 24, 2022
May 3, 2022
Oct 17, 2022
Jul 18, 2023
May 24, 2022
Jun 27, 2022
Oct 20, 2022
Mar 27, 2023
Jul 30, 2021
Feb 28, 2023
Oct 11, 2022
Aug 17, 2021
Jul 30, 2021
Sep 7, 2022
Mar 6, 2023
May 24, 2022
Jul 18, 2023
May 24, 2022
Jan 11, 2023
Jul 18, 2023
Sep 30, 2022
Jul 18, 2023
Apr 17, 2023

Repository files navigation

Nodejs Integration Bundler codecov Chat PRs welcome!

OpenSearch logo

OpenSearch Node.js client

Welcome!

opensearch-js is a community-driven, open source fork of elasticsearch-js licensed under the Apache v2.0 License. For more information, see opensearch.org.

Example use

The OpenSearch JavaScript client provides a safer and easier way to interact with your OpenSearch cluster. Rather than using OpenSearch from the browser and potentially exposing your data to the public, you can build an OpenSearch 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 @opensearch-project/opensearch

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

Then require the client:

const { Client } = require('@opensearch-project/opensearch');

Sample code

Please see the USER_GUIDE for code snippets.

Project Resources

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 opensource-codeofconduct@amazon.com with any additional questions or comments.

License

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

Copyright

Copyright OpenSearch Contributors. See NOTICE for details.