Class ReflectivePlugin

constructor

• new ReflectivePlugin(
      descriptor: PluginApiDescriptor,
      registry: Registry,
      transport: Transport,
  ): ReflectivePlugin

  Parameters

  • descriptor: PluginApiDescriptor
  • registry: Registry
  • transport: Transport

  Returns ReflectivePlugin

Readonlydescriptor

call

• call(
      serviceName: string,
      methodName: string,
      input: JsonValue,
      options?: CallOptions,
  ): Effect<ReflectiveMessage, SoulFireOperationError>

  Parameters

  • serviceName: string
  • methodName: string
  • input: JsonValue
  • Optionaloptions: CallOptions

  Returns Effect<ReflectiveMessage, SoulFireOperationError>

events

• events(
      options?: Omit<WatchPluginEventOptions, "pluginIds">,
  ): Stream<ReflectivePluginEvent, SoulFireOperationError>

  Watches events published by this plugin and decodes their payloads from the plugin's downloaded descriptor set.

  Parameters

  • options: Omit<WatchPluginEventOptions, "pluginIds"> = {}

  Returns Stream<ReflectivePluginEvent, SoulFireOperationError>

startTask

• startTask(
      tasks: SoulFireTasks,
      inputTypeUrl: string,
      input: JsonValue,
      options?: TaskStartOptions,
  ): Effect<SoulFireTask<DescMessage>, SoulFireOperationError>

  Starts a plugin-defined task using its downloaded request and result descriptors. Generated companion SDKs expose a statically typed method for the same operation.

  Parameters

  • tasks: SoulFireTasks
  • inputTypeUrl: string
  • input: JsonValue
  • options: TaskStartOptions = {}

  Returns Effect<SoulFireTask<DescMessage>, SoulFireOperationError>

stream

• stream(
      serviceName: string,
      methodName: string,
      input: JsonValue,
      options?: CallOptions,
  ): Stream<ReflectiveMessage, SoulFireOperationError>

  Parameters

  • serviceName: string
  • methodName: string
  • input: JsonValue
  • Optionaloptions: CallOptions

  Returns Stream<ReflectiveMessage, SoulFireOperationError>