@zcatalyst/circuit

ZOHO CATALYST SDK for JavaScript Circuit for Node.js and Browser.

Installing

To install this package, simply type add or install @zcatalyst/circuit using your favorite package manager:

• npm install @zcatalyst/circuit
• yarn add @zcatalyst/circuit
• pnpm add @zcatalyst/circuit

Getting Started

Import

The Catalyst SDK is modulized by Components. To send a request, you only need to import the Circuit:

// ES5 example
const { Circuit } = require('@zcatalyst/circuit');

// ES6+ example
import { Circuit } from '@zcatalyst/circuit';

Usage

To send a request, you:

• Create a Circuit Instance.
• Call the Circuit operation with input parameters.

const circuit = new Circuit();

const circuit = await circuit.execute('195000000041001', 'sampleName', { name: 'Aaron Jone'});

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
const data = await circuit.execute('195000000041001', 'sampleName', { name: 'Aaron Jone'});
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

circuit.execute('195000000041001', 'sampleName', { name: 'Aaron Jone'})
.then(
	(data) => {
		// process data.
	},
	(error) => {
		// error handling.
	}
);

Promises can also be called using .catch() and .finally() as follows:

circuit.execute('195000000041001', 'sampleName', { name: 'Aaron Jone'})
.then((data) => {
	// process data.
})
.catch((error) => {
	// error handling.
})
.finally(() => {
	// finally.
});

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
circuit.execute('195000000041001', 'sampleName', { name: 'Aaron Jone'},
(err, data) => {
	// process err and data.
}
);

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
const data = await circuit.execute('195000000041001', 'sampleName', { name: 'Aaron Jone'});
// process data.
} catch (error) {
const message = error.message;
const status = error.statusCode;
console.log({ message, status });
}

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information on how to get started.

License

This SDK is distributed under the Apache License 2.0. See LICENSE file for more information.

Circuit operations