modules.IServiceOptions

Options, used to register a Function.

Export

IServiceOptions

Name	Type
T	any

• Partial<ICallOptions>

  ↳ IServiceOptions

Optional id: string

Instead of generating a uuid an id could be provided

Memberof

IServiceOptions

---

Optional isDynamic: boolean

Flag, to indicate, that the Item is dynamic.

Memberof

IServiceOptions

---

Optional package: string

The Package of the service to list it in.

---

Optional resultSink: string

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

Author

M.Karkowski

Memberof

ICallOptions

Partial.resultSink

---

schema: INopeDescriptor

Schema of the Function.

Memberof

IServiceOptions

---

Optional 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

Partial.timeout

---

Optional ui: Object

The ui definition of the service.

Name	Type	Description
autoGenBySchema?	true | { getData?: (item: { [index: string]: any; }) => T ; getDescriptionText?: (item: { [index: string]: any; }) => string ; getPorts?: (item: { [index: string]: any; }) => TServiceGetPortsReturn }	Helper to enable auto generating a configuration
getPorts?	TGetPorts<T, {}>	Helper to generate the Pors based on the provided node data.
icon?	string	Helper to get the Icon, it must be available under 'assets/icons/{icon}.png'. Just enter the name
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.
serviceConfiguration?	TRenderConfigureServicePage<T, {}>	Custom function to render the service in the editor