Interface IServiceOptions<T>

Options, used to register a Function.

Export

IServiceOptions

Type Parameters

  • T = any

Hierarchy

Properties

id? isDynamic? package? resultSink? schema timeout? ui?

Properties

Optional id

id?: string

Instead of generating a uuid an id could be provided

Memberof

IServiceOptions

Optional isDynamic

isDynamic?: boolean

Flag, to indicate, that the Item is dynamic.

Memberof

IServiceOptions

Optional package

package?: string

The Package of the service to list it in.

Optional resultSink

resultSink?: string

Desired result sink. If implemented, the result will be published on this topic as well.

Author

M.Karkowski

Memberof

ICallOptions

schema

schema: INopeDescriptor

Schema of the Function.

Memberof

IServiceOptions

Optional timeout

timeout?: number

A User Provided Timeout of the call. After the timeout has been ellapsed, the task is cancelled with a timeout error. The Time is given in ms

Optional ui

ui?: {
    autoGenBySchema?: true | {
        getData?: ((item) => T);
        getDescriptionText?: ((item) => string);
        getPorts?: ((item) => TServiceGetPortsReturn);
    };
    getPorts?: TGetPorts<T, {}>;
    icon?: string;
    requiredProvidersForRendering?: string[];
    serviceConfiguration?: TRenderConfigureServicePage<T, {}>;
}

The ui definition of the service.

Type declaration

  • Optional autoGenBySchema?: true | {
        getData?: ((item) => T);
        getDescriptionText?: ((item) => string);
        getPorts?: ((item) => TServiceGetPortsReturn);
    }

    Helper to enable auto generating a configuration

  • Optional getPorts?: TGetPorts<T, {}>

    Helper to generate the Pors based on the provided node data.

  • Optional icon?: string

    Helper to get the Icon, it must be available under 'assets/icons/{icon}.png'. Just enter the name

  • Optional requiredProvidersForRendering?: string[]

    Flag to indicate, that rendering the service configuration requires a provider itself. This for instance is the case, if some functions needs to be called.

  • Optional serviceConfiguration?: TRenderConfigureServicePage<T, {}>

    Custom function to render the service in the editor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc