Hazelcast client instance. When you want to use Hazelcast's distributed data structures, you must first create a client instance. Multiple instances can be created on a single Node.js process.
Client instances should be shut down explicitly.
Registers a distributed object listener to cluster.
distributed object listener function.
registration id of the listener.
Returns the CP subsystem that offers a set of in-memory linearizable data structures.
Returns the Cluster to which this client is connected.
Returns configuration that this instance started with. The returned object should not be modified.
Gives all known distributed objects in the cluster.
Returns the distributed Flake ID Generator instance with given name.
Returns the lifecycle service for this client.
Returns the distributed List instance with given name.
Gathers information of this local client.
Returns the distributed Map instance with given name.
Returns the distributed MultiMap instance with given name.
Returns the name of this Hazelcast instance.
Returns the distributed PN Counter instance with given name.
Returns the partition service of this client.
Returns the distributed Queue instance with given name.
Returns a distributed Reliable Topic instance with the given name.
Returns the distributed Replicated Map instance with given name.
Returns a distributed Ringbuffer instance with the given name.
Returns the distributed Set instance with given name.
Returns a service to execute distributed SQL queries. The service is in beta state. Behavior and API might be changed in future releases.
Removes a distributed object listener from the cluster.
id of the listener to be removed.
true if registration was removed,
Shuts down this client instance.
Creates a new client object and automatically connects to cluster.
Client config. Default client config is used when this parameter is absent.
a new client instance
Creates a client with cluster switch capability. Client will try to connect to alternative clusters according to failover configuration when it disconnects from a cluster.
Configuration object describing the failover client configs and try count
a new client instance
Generated using TypeDoc