Socket
Socket
Sign inDemoInstall

@interopio/core

Package Overview
Dependencies
0
Maintainers
8
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @interopio/core

IOConnect core library


Version published
Weekly downloads
464
increased by83.4%
Maintainers
8
Install size
1.40 MB
Created
Weekly downloads
 

Readme

Source

Overview

The @interopio/core package is the core IO Connect JavaScript module used in applications for sharing data with other IO Connect enabled applications. It can be used by applications hosted in IO Connect, a browser or Node.js.

The @interopio/core package is a subset of the @glue42/desktop package which offers tools for more advanced scenarios that require Window Management, Application Management, Activities, Layouts, Channels, etc.

The @interopio/core package contains the following APIs:

  • Interop - an Interop API which enables applications to:

    • offer functionality to other applications (JavaScript and native) by registering Interop methods;
    • discover Interop methods and applications which offer Interop methods;
    • invoke Interop methods on the user desktop and across the network;
    • stream and subscribe to real-time data using a Streaming API;
  • Shared Contexts - a Shared Contexts API which provides a simple and effective way of sharing data between applications by using shared named data objects;

  • Metrics - use the IO Connect Metrics as a way of assessing the life cycle of a certain process (application performance, business process, employee productivity, etc.) by acquiring, recording and monitoring over time specific data about the key performance indicators of the said process;

  • Pub/Sub - a basic Pub/Sub API that allows apps to publish/subscribe for messages on a specific topic;

Usage

Running in IO Connect

import IOConnectCore from "@interopio/core";

const initializeIOConnectCore = async () => {
    // You can pass an optional configuration object to the factory function.
    // If you do not privide configuration, it will be inferred from your application configuration file.
    const io = await IOConnectCore();

    // Use the IO Connect APIs.
};

// Handle errors.
initializeIOConnectCore().catch(console.error);

Running in Node.js

Note that your Node.js script should be started by the IO Connect Desktop client in order to receive a gwToken and a gwURL.

import IOConnectCore from "@interopio/core"

const initializeIOConnectCore = async () => {

    const config = {
        application: "MyNodeApp",
        gateway: {
            protocolVersion: 3,
            ws: process.env.gwURL
        },
        auth: {
            gatewayToken: process.env.gwToken
        }
    };

    const io = await IOConnectCore(config);

    // Use the IO Connect APIs.
};

// Handle errors.
initializeIOConnectCore().catch(console.error);

Keywords

FAQs

Last updated on 23 May 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc