-
Notifications
You must be signed in to change notification settings - Fork 107
DOC-548: Migrate tech content from node.js readme & ref manual to Docs #1791
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
24bf431
DOC-548: add readme content WIP
amandalindsay 59e6569
DOC-548: add info from readme & ref manual
amandalindsay cce6a0b
DOC-548: tweaks
amandalindsay 10e93d5
DOC-548: tweaked links, removed comments
amandalindsay 479d87c
DOC-548: updates to feature list
amandalindsay b92bdd7
Merge branch 'main' into DOC-548
amandalindsay 016fae2
Merge branch 'main' into DOC-548
amandalindsay 0bdef28
Update docs/modules/clients/pages/nodejs.adoc
amandalindsay 37415b5
Update docs/modules/clients/pages/nodejs.adoc
amandalindsay a2ee95c
Update docs/modules/clients/pages/nodejs.adoc
amandalindsay bb8f225
DOC-548: updates from feedback
amandalindsay 7f54fcf
Merge branch 'DOC-548' of https://github.com/hazelcast/hz-docs into D…
amandalindsay 8b7e3e8
Merge branch 'main' into DOC-548
amandalindsay d24e2c5
Update docs/modules/clients/pages/nodejs.adoc
amandalindsay 0c9fa92
Update docs/modules/clients/pages/nodejs.adoc
amandalindsay e79a8a0
Update docs/modules/clients/pages/nodejs.adoc
amandalindsay 05b4fb9
Update docs/modules/clients/pages/nodejs.adoc
amandalindsay 14f7793
Update docs/modules/clients/pages/nodejs.adoc
amandalindsay File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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: | ||
|
|
||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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**. | ||
|
|
@@ -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. | ||
|
|
||
|
|
@@ -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 | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.