Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CoordinatorConstructor

The basic interface of a Coordinator constructor.

Hierarchy

  • CoordinatorConstructor

Index

Constructors

Constructors

constructor

  • new CoordinatorConstructor(brokerUrl: string, localDeviceUrl: string, clientId: string, credentials: Credentials): Coordinator
  • A basic constructor and parameters required to connect to the YanuX Broker.

    Parameters

    • brokerUrl: string

      The URL of the broker that the FeathersCoordinator should connect to.

    • localDeviceUrl: string

      The URL of that exposes information about the local device (e.g., the Device UUID).

    • clientId: string

      The Client Id used that identifies the application using this FeathersCoordinator instance

    • credentials: Credentials

      The authentication credentials used to identify the user and that authorize the access to their data.

    Returns Coordinator

Generated using TypeDoc