Variable ifaceConst

Type Declaration

• implement: {
      <P extends string, H extends Record<string, HandlerDescriptor>>(
          iface: ServiceDescriptor<P, H>,
          config: {
              handlers: ImplementHandlers<H>;
              options?: ServiceOptions & {
                  handlers?: Partial<Record<keyof H, GenHandlerOpts>>;
              };
          },
      ): ImplementedServiceDefinition<P, H>;
      <P extends string, H extends Record<string, HandlerDescriptor>>(
          iface: ObjectDescriptor<P, H>,
          config: {
              handlers: ImplementHandlers<H>;
              options?: ServiceOptions & { enableLazyState?: boolean } & {
                  handlers?: Partial<Record<keyof H, GenObjectHandlerOpts>>;
              };
          },
      ): ImplementedObjectDefinition<P, H>;
      <P extends string, H extends Record<string, HandlerDescriptor>>(
          iface: WorkflowDescriptor<P, H>,
          config: {
              handlers: ImplementHandlers<H>;
              options?: ServiceOptions & {
                  enableLazyState?: boolean;
                  workflowRetention?: number | Duration;
              } & { handlers?: Partial<Record<keyof H, GenWorkflowHandlerOpts>> };
          },
      ): ImplementedWorkflowDefinition<P, H>;
  }

• shared: {
      json<I = void, O = void>(
          opts?: DescriptorOpts,
      ): HandlerDescriptor<I, O, true>;
      schemas<
          SI extends StandardSchemaV1<any, any>,
          SO extends StandardSchemaV1<any, any>,
      >(
          opts: { input?: SI; output?: SO } & DescriptorOpts,
      ): HandlerDescriptor<
          StandardSchemaV1.InferOutput<NonNullable<SI>>,
          StandardSchemaV1.InferOutput<NonNullable<SO>>,
          true,
      >;
      serdes<SI extends Serde<any>, SO extends Serde<any>>(
          opts: { input?: SI; output?: SO } & DescriptorOpts,
      ): HandlerDescriptor<SerdeType<SI>, SerdeType<SO>, true>;
  }

  Shared (read-only) virtual-object / non-run workflow handler declarators.

• json: function

  • json<I = void, O = void>(opts?: DescriptorOpts): HandlerDescriptor<I, O, false>

    json<I, O>() — type params, default JSON serde.

    Type Parameters

    • I = void
    • O = void

    Parameters

    • Optionalopts: DescriptorOpts

    Returns HandlerDescriptor<I, O, false>

• object: function

  • object<
        P extends string,
        H extends Record<string, HandlerDescriptor<any, any, boolean>>,
    >(
        name: P,
        handlers: H,
        opts?: DescriptorOpts,
    ): ObjectDescriptor<P, H>

    Type Parameters

    • P extends string
    • H extends Record<string, HandlerDescriptor<any, any, boolean>>

    Parameters

    • name: P
    • handlers: H
    • Optionalopts: DescriptorOpts

    Returns ObjectDescriptor<P, H>

• schemas: function

  • schemas<
        SI extends StandardSchemaV1<any, any>,
        SO extends StandardSchemaV1<any, any>,
    >(
        opts: { input?: SI; output?: SO } & DescriptorOpts,
    ): HandlerDescriptor<
        StandardSchemaV1.InferOutput<NonNullable<SI>>,
        StandardSchemaV1.InferOutput<NonNullable<SO>>,
        false,
    >

    schemas({ input, output }) — Standard Schema per direction.

    Type Parameters

    • SI extends StandardSchemaV1<any, any>
    • SO extends StandardSchemaV1<any, any>

    Parameters

    • opts: { input?: SI; output?: SO } & DescriptorOpts

    Returns HandlerDescriptor<
        StandardSchemaV1.InferOutput<NonNullable<SI>>,
        StandardSchemaV1.InferOutput<NonNullable<SO>>,
        false,
    >

• serdes: function

  • serdes<SI extends Serde<any>, SO extends Serde<any>>(
        opts: { input?: SI; output?: SO } & DescriptorOpts,
    ): HandlerDescriptor<SerdeType<SI>, SerdeType<SO>, false>

    serdes({ input, output }) — explicit Serde per direction.

    Type Parameters

    • SI extends Serde<any>
    • SO extends Serde<any>

    Parameters

    • opts: { input?: SI; output?: SO } & DescriptorOpts

    Returns HandlerDescriptor<SerdeType<SI>, SerdeType<SO>, false>

• service: function

  • service<
        P extends string,
        H extends Record<string, HandlerDescriptor<any, any, boolean>>,
    >(
        name: P,
        handlers: H,
        opts?: DescriptorOpts,
    ): ServiceDescriptor<P, H>

    Type Parameters

    • P extends string
    • H extends Record<string, HandlerDescriptor<any, any, boolean>>

    Parameters

    • name: P
    • handlers: H
    • Optionalopts: DescriptorOpts

    Returns ServiceDescriptor<P, H>

• workflow: function

  • workflow<
        P extends string,
        H extends Record<string, HandlerDescriptor<any, any, boolean>>,
    >(
        name: P,
        handlers: H,
        opts?: DescriptorOpts,
    ): WorkflowDescriptor<P, H>

    Type Parameters

    • P extends string
    • H extends Record<string, HandlerDescriptor<any, any, boolean>>

    Parameters

    • name: P
    • handlers: H
    • Optionalopts: DescriptorOpts

    Returns WorkflowDescriptor<P, H>