Home > @i2analyze/i2connect > connector

connector() function

The @connector decorator, which configures a class to be a connector for the i2 Connect server.

Signature:

export declare function connector(config?: connectors.IConnectorConfig): ClassDecorator;

Introduced: API version 1.0

Parameters

Parameter	Type	Description
config	connectors.IConnectorConfig	Settings that determine the name and description of the connector that users see, and some aspects of its behavior.

Returns:

ClassDecorator

Example

@connector({
  name: "Sample Connector",
  description: "A sample connector"
})
export class SampleConnector {...}