Table of Contents

• Hazelcast Node.js Client
• Features
• Installing the Client
• Using the Client
• Development
  • Building And Installing from Sources
  • Using Locally Installed Package
• Testing
  • Testing Prerequisites
  • Running the Tests
• Release Notes
• Mail Group
• License
• Copyright

Hazelcast Node.js Client

NOTE: This project is currently in active development.

This document explains Node.js client for Hazelcast which uses Hazelcast's Open Client Protocol 1.0. This client works with Hazelcast 3.6 and higher.

Hazelcast is a clustering and highly scalable data distribution platform. With its various distributed data structures, distributed caching capabilities, elastic nature and more importantly with so many happy users, Hazelcast is a feature-rich, enterprise-ready and developer-friendly in-memory data grid solution.

Features

Hazelcast Node.js client supports the following data structures and features:

• Map (including entry processors and PartitionAware keys) and MultiMap
• Queue, Set, and List
• Lock
• Smart Client
• Hazelcast Native Serialization
• Distributed Object Listener
• Lifecycle Service

Installing the Client

Following command installs Hazelcast Node.js client:

npm install hazelcast-client --save

Using the Client

Following script illustrates a basic example in which a map is created in Hazelcast Node.js client and an entry is added to that map:

var HazelcastClient = require('hazelcast-client').Client;
var person = {
    firstName: "Joe",
    lastName: "Doe",
    age: 42
};
var map;
HazelcastClient.newHazelcastClient().then(function (hazelcastClient) {
    map = hazelcastClient.getMap("personMap");
    map.put(1, person).then(function (val) {
        // prints previous value for key `1`
        console.log(val);
    });
    map.get(1).then(function (value) {
        console.log(value);
    })
});

Please see Hazelcast Node.js code samples for more examples.

You can also refer to Hazelcast Node.js API Documentation.

Development

Building And Installing from Sources

Follow the below steps to build and install Hazelcast Node.js client from its source:

• Clone the GitHub repository https://github.com/hazelcast/hazelcast-nodejs-client.git.
• Install the dependencies using the command npm install.
• Compile TypeScript using the command npm run compile.
• Link the package locally using the command npm link.
• Run static analysis tool using the command npm run lint

Using Locally Installed Package

• Change directory to the project directory.
• Use a locally linked module: npm link hazelcast-client.
• Tryout the example shown in Using the Client section.

Testing

Testing Prerequisites

• Java 6+

• Maven

  Maven automatically downloads hazelcast-remote-controller and hazelcast from maven repository.
  

Running the Tests

Following command starts the tests:

npm test

Release Notes

You can see the release notes for each release on the Releases page.

Mail Group

Please join the mail group if you are interested in using or developing Hazelcast.

http://groups.google.com/group/hazelcast

License

Hazelcast is available under the Apache 2 License. Please see the Licensing appendix for more information.

Copyright

Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.

Visit www.hazelcast.com for more information.