• Preparing search index...
  • The search index is not available
@sodazone/ocelloids-client - v2.5.0
  • @sodazone/ocelloids-client
  • agent
  • createXcmAgent

Function createXcmAgent

  • createXcmAgent(
        optsOrClient: OcelloidsClientConfig | OcelloidsClient,
    ): SubscribableApi<XcmInputs, sourceXcm.XcmMessagePayload> & OcelloidsClientApi

    Creates an 'xcm' agent instance.

    Parameters

    • optsOrClient: OcelloidsClientConfig | OcelloidsClient

      Configuration options for the OcelloidsClient, or an existing OcelloidsClient instance.

    Returns SubscribableApi<XcmInputs, sourceXcm.XcmMessagePayload> & OcelloidsClientApi

    An object with methods for subscribing to XCM events and accessing general client API methods.

    Example

    import { createXcmAgent } from "@sodazone/ocelloids-client";

    const agent = createXcmAgent({
    httpUrl: "http://127.0.0.1:3000",
    wsUrl: "ws://127.0.0.1:3000"
    });

    // Subscribe to XCM events
    const ws = await agent.subscribe(...);
    • Defined in client/src/agent.ts:56

Settings

Member Visibility
@sodazone/ocelloids-client - v2.5.0
  • Loading...