1.0.0 • Published 5 years ago

uim_node_pu v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

Node Probe Utility

Maintenance GitHub license V1.0 1DEP

CA UIM - Node.js Probe Utility interface.

This package has been designed to replace nodeuim.

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i uim_node_pu
# or
$ yarn add uim_node_pu

Usage example

const { pu, PDS_VOID } = require("uim_node_pu");

async function main() {
    const nimSoft = pu({
        login: "adminitrator",
        password: "NimSoft!01",
        path: "/opt/nimsoft/bin/pu"
    });

    const response = await nimSoft("getrobots", [PDS_VOID, PDS_VOID]);
    console.log(JSON.stringify(response, null, 4));
}
main().catch(console.error);

API

PDS_VOID

Constant variable equal to ''. Use this when you want to enter empty Probe Utility argument (if not entered, the call will timeout).

pu(options: PUOptions): ProbeUtility.Request

Instanciate/Create a new ProbeUtility gateway.

Available options are:

interface PUOptions {
    login: string;
    password: string;
    path: string;
    debug?: boolean;
    timeout?: number;
}

ProbeUtility.Request(fullAddr: string, args?: (string | number)[]): any

Send a new request to Probe Utility. fullAddr can be callback name or the full NimSoft ADDR, ex:

hub/getrobots
domain/hub/robot/hub/getrobots

Roadmap 1.1

  • Implement a NimAddr class

Licence

MIT