Home > @i2analyze/i2connect

i2connect package

The i2 Connect package, which contains all the functionality you need to create connectors for i2 Analyze.

Classes

Class	Description
AuthenticationRequiredError	An error indicating that authentication is required.
DetailedError	An error indicating that a problem occurred during a service call.

Functions

Function	Description
addService(config, acquire)	Adds a service that provides an acquire callback to the connector.
addService(config, callbacks)	Adds a service that provides an acquire callback and an optional validate callback to the connector.
addVisualQueryService(config, acquire)	Adds a visual query service that provides an acquire callback to the connector.
addVisualQueryService(config, callbacks)	Adds a visual query service that provides an acquire callback and an optional validate callback to the connector.
createAuthenticator(config, authenticate)	Creates an authenticator, which performs user authentication.
createLogger(id)	Creates or retrieves a logger object with the specified identifier.
startConnector(config)	Starts the connector. You must add all the services you need before you call this function.

Interfaces

Interface	Description
IDetailedErrorData	A set of detailed error information for a DetailedError object.
ILogger	A diagnostic logger that i2 Connect services can use.

Namespaces

Namespace	Description
connectors	The members of the connectors namespace allow you to configure the connectors that you create for the i2 Connect server.
data	The members of the data namespace provide access to the property values of records that an i2 Connect service operates on.
records	The members of the records namespace provide access to the contents of seed and result records in an i2 Connect service.
schema	The members of the schema namespace provide access to the specifications that govern the structure of records in an i2 Connect service.
services	The members of the services namespace allow you to configure and implement the services in a connector.
settings	The members of the settings namespace allow you to retrieve connector settings from environment variables and the configuration file.
spi	A JavaScript representation of the objects in the raw i2 Connect gateway REST SPI.
utility	The members of the utility namespace improve the TypeScript type information that's based on service configuration. You will rarely need to use the members of this namespace directly in your connector code.

Type Aliases

Type Alias	Description
LogLevel	The logging level, or severity, of log messages.