Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/modules/clients/pages/nodejs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@

== Overview

This section provides information about the Node.js client for Hazelcast, and explains how to install and get started with the client.
This section provides information about the Node.js client for Hazelcast, and explains how to install and get started with the client.

TIP: To learn how to get started quickly with the Hazelcast Node.js client, follow our simple xref:clients:nodejs-client-getting-started.adoc[Get started with Node.js] tutorial.

The official Hazelcast Node.js client is a library that allows Node.js applications to connect to and interact with a Hazelcast cluster, enabling features such as distributed maps, caching, and more. It provides a promise-based API with built-in support for native JavaScript objects. The key features and benefits include:


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not very important, but an extra blank line was introduced here.

* Distributed, partitioned and queryable in-memory key-value store implementation, called **Map**.
* Eventually consistent cache implementation to store a subset of the Map data locally in the memory of the client, called **Near Cache**.
* Additional data structures and simple messaging constructs such as **Set**, **MultiMap**, **Queue**, **Topic**.
Expand Down Expand Up @@ -55,11 +56,8 @@ The Hazelcast log appears in the terminal showing that your 1-member cluster is

Use the `npm install` command to install the Hazelcast Node.js client library into your project.

// Author's Note: Yuce - I notice that in the doc.md file, there's a '--save' added to this command but it's not in the readme.
// Should we include and, if so, what does '--save' do?

```bash
npm install hazelcast-client
npm install hazelcast-client --save
```
After running this command, you can use the Hazelcast client in your Node.js code to access Hazelcast data structures and services.

Expand Down Expand Up @@ -133,7 +131,8 @@ await client.shutdown();
```

To learn more about supported configuration options, see the
https://github.com/hazelcast/hazelcast-nodejs-client/blob/v5.3.0/DOCUMENTATION.md[Node.js client documentation]
https://github.com/hazelcast/hazelcast-nodejs-client/blob/master/DOCUMENTATION.md[Node.js client documentation]


== Get support

Expand Down
Loading