@finos/fdc3-get-agent v2.2.1-beta.3

FDC3 Agent Proxy

Contains the main entry point for the Financial Desktop Connectivity and Collaboration Consortium (FDC3) JavaScript API, via the getAgent function.

Installation

To install the FDC3 module, use npm:

npm install @finos/fdc3-get-agent

Usage

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

import { getAgent } from '@finos/fdc3-get-agent';
// getAgent() returns the FDC3 Desktop Agent
const fdc3 = await getAgent();

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

fdc3.raiseIntent('ViewProfile', contact);

Documentation

For detailed documentation and API reference, please visit the official FDC3 documentation.

Contributing

We welcome contributions to the FDC3 project. Please see our contributing guidelines for more information.

License

This project is licensed under the Apache 2.0 License.

Contact

For any questions or support, please reach out to the FDC3 community on our Slack channel or mailing list.

Further Details

Further details are avilable in the main FDC3 Project README