RpcDotNet-Connector

This package provides the functionality for invoking RPC.NET services.

This documentation refers the version 3.X of the library

How to use it

1. Reference this library via jsdelivr: <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/apiconnector.js"></script> or install as an NPM package: npm install --save-prod [email protected]
2. Create an API connection:

   const { ApiConnection } = window.apiconnector;  // or "import { ApiConnection } from 'rpcdotnet-connector'" 
   ...
   const conn = new ApiConnection('http://127.0.0.1:1986/api');
   // Setting the following properties is not required
   conn.sessionId = 'xXx';
   conn.timeout = 5000; // ms

   Optionally you can hook into the invocation process for instance, to bind your loader:

   conn.onFetch(async function(...args) {
     _yourLoaderService.activated++;
     try {
       return await this(...args);
     } finally {
       _yourLoaderService.activated--;
     }
   });

3. Invoke the remote module:

   // every method invocations are async
   const result = await conn.invoke('ICalculator' /*module*/, 'Add' /*method*/, [1, 2] /*args*/);

Schema API

In practice the invoke() method is considered internal. So instead of it, we may use the schema API that creates a "well defined" client against the schema provided by the remote server:

const calculator = await conn.createAPI('ICalculator');
...
await calculator.add(1, 2); // by default "camelCase" naming convention is used

FYI: The schema itself looks like:

{
  "ICalculator": {
    "Methods": {
      "Add": {...},
      "ParseInt": {...}
    },
    "Properties": {
        "PI": {...}
    }
  }
}

Version history

Can be found here.