Node.js Client-side Prerequisites
To practically utilize the powerful features of the NCache Node.js client, ensure that your application environment is properly configured with the required prerequisites. This includes installing the ncache-client npm package, verifying that the target cache is running, establishing a connection to the cache, ensuring application data is serializable, and implementing proper exception handling. Once configured, the NCache Node.js client provides support for distributed caching features such as tags, expiration, data structures, events, and publish/subscribe, making it suitable for high-performance Node.js microservices, APIs, and real-time applications.
Prerequisites
Install and include the following module in your Node.js client application:
- Enterprise: ncache-client
Include the following class in your application:
- The cache must be running.
- Make sure that the data being added is serializable.
- The application must be connected to cache before performing the operation.
- To ensure the operation is fail-safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.
- To handle any unseen exceptions, refer to the Troubleshooting section.
Feature Specific Namespaces
Aside from the namespaces employed in most features, you should add the following namespaces/packages/classes in your Node.js client application based on the feature/API you intend to use.
Note
Any feature not mentioned in the list below either does not work with the specified feature or only requires the general namespaces/packages/classes.
- For Tags & Named Tags, and Expirations:
- For Cache Data Dependencies e.g. KeyDependency, FileDependency, and Database Dependencies: [Deprecated]
- For Data Structures:
- For Event Notifications
- For Continuous Query: [Deprecated]
- For Pub/Sub: