Skip to main content Link Search Menu Expand Document (external link)

WorkflowProxyServer.ts overview

Since v1.0.0


Exports Grouped by Category


Layers

layerHttpApi

Signature

declare const layerHttpApi: <
  ApiId extends string,
  Groups extends HttpApiGroup.Any,
  ApiE,
  ApiR,
  Name extends HttpApiGroup.Name<Groups>,
  const Workflows extends NonEmptyReadonlyArray<Workflow.Any>
>(
  api: HttpApi.HttpApi<ApiId, Groups, ApiE, ApiR>,
  name: Name,
  workflows: Workflows
) => Layer.Layer<
  ApiGroup<ApiId, Name>,
  never,
  WorkflowEngine | Workflow.Registrations<Workflows[number]> | Workflow.Requirements<Workflows[number]>
>

Source

Since v1.0.0

layerRpcHandlers

Signature

declare const layerRpcHandlers: <
  const Workflows extends NonEmptyReadonlyArray<Workflow.Any>,
  const Prefix extends string = ""
>(
  workflows: Workflows,
  options?: { readonly prefix?: Prefix }
) => Layer.Layer<
  RpcHandlers<Workflows[number], Prefix>,
  never,
  WorkflowEngine | Workflow.Registrations<Workflows[number]> | Workflow.Requirements<Workflows[number]>
>

Source

Since v1.0.0

utils

RpcHandlers (type alias)

Signature

type RpcHandlers<Workflows, Prefix> =
  Workflows extends Workflow.Workflow<infer _Name, infer _Payload, infer _Success, infer _Error>
    ? Rpc.Handler<`${Prefix}${_Name}`> | Rpc.Handler<`${Prefix}${_Name}Discard`>
    : never

Source

Since v1.0.0