Skip to main content

Type Alias: StricliIntegration<CONTEXT>

StricliIntegration<CONTEXT>: object

An integration is a set of additional functionality that can apply to application runs without modifying the structure of the application itself.

Type Parameters

CONTEXT extends CommandContext

Type declaration

flag?

readonly optional flag: Omit<ApplicationFlag<CONTEXT>, "name">

If provided, registers an additional flag in the application to provide custom functionality.

hooks?

readonly optional hooks: LifecycleHooks<CONTEXT>

Lifecycle hooks provided by the integration that should be executed at the appropriate times during the application lifecycle.

validate()?

readonly optional validate: (root, config) => void

Additional validation that can be performed by the integration when the application is built. This can be used to ensure that the integration is compatible with the application configuration. If the validation fails, an error should be thrown. The integration name will be included in the error message, so it is not necessary to include it in the error message thrown by the integration.

Parameters

root: RoutingTarget<CONTEXT>

config: ApplicationConfiguration

Returns

void

Defined in

packages/core/src/application/integration.ts:315