End House Software support Module

End House Software support Module.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To run locally you need the NodeJS software installed (the npm package manager is bundled with NodeJS).

The Backendless server (create account) is used to persist the contents of the data structures. Create a Backendless application and store the APP ID and JS API KEY values in the following environment variables - BACKENDLESS_APP_ID and BACKENDLESS_API_KEY.

Note 1: When we create the data structure, e.g a hash table, it will read any existing data for the data structure from Backendless which it will then delete. This enables us to use the data structure without the overhead of updating Backendless as we update the data structure. Before exiting the application, if required we can call the persist function of the data structure to update Backendless.

Note 2: The name of the data structure must be unique across all data structure types as it is used as a key to an internal hash table.

To edit source code, right-click on project's directoy, e.g ehssupport and select Open with Code menu option.

Deployment

Install ehs support module in project ...

npm install --save ehssupport

and then ...

var support = require('ehssupport');

(a) Hash Table

support.initHashTable(name,callback)

support.clearHashTable(name,callback)

support.getHashItem(name,key,callback)

	e.g. support.getHashItem("gavin","key1",function(err, result) {
		console.log("getHashItem: " + result);
	});

support.setHashItem(name,key,value,callback)

	e.g. support.setHashItem("internalDataStructures","key1","value1",function(err,result) {
		console.log("setHashItem: " + result);
	});

support.getHashLength(name,callback)

	e.g. support.getHashLength("internalDataStructures",function(err, result) {
		console.log("getHashLength: " + result);
	});

support.getHashKeys(name,callback)

support.getHashValues(name,callback)

support.deleteHashItem(name,key,callback)

support.saveHashTable(name,callback)

(b) General

support.getVersionString()

support.calcMD5(str)

Built With

• Visual Studio Code - IDE enviroment.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning.

Authors

• Gavin Baker - Initial work - End House Software.
• Paul Johnston and Greg Holt - calcMD5(str).

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

First and foremost many thanks to the support of family and friends. Any code adapted from public available sources have the appropriate acknowledgements documented in source code comments.