@finos/fdc3-commonjs NPM

FDC3 CommonJS Module

This is the CommonJS module version of the Financial Desktop Connectivity and Collaboration Consortium (FDC3) javascript API.

Warning

CommonJS is no longer the recommended module system for JavaScript. We recommend using the FDC3 ES6 module at @finos/fdc3 instead. The FDC3 CommonJS module is provided for compatibility with older projects that use CommonJS.

Installation

To install the FDC3 CommonJS module, use npm:

npm install @finos/fdc3-commonjs

Usage

To use the FDC3 CommonJS module in your project, require it as follows:

const fdc3CommonJs = require('@finos/fdc3-commonjs');

// getAgent() returns the FDC3 Desktop Agent
const fdc3 = fdc3CommonJs.getAgent();

// Example usage
const contact = {
  type: 'fdc3.contact',
  name: 'Jane Doe',
  id: {
    email: 'jane@mail.com'
  }
};

fdc3.raiseIntent('ViewProfile', contact);