Alokai

IntegrationLoaded

interface IntegrationLoaded<CONFIG extends ApiClientConfig, API extends ApiMethods> {
	apiClient: ApiClientFactory<CONFIG, API>;
	circuitBreaker?: {
    granularity?: CircuitBreakerGranularity;
    methods?: string[];
    preset: CircuitBreakerPreset;
  };
	configuration: CONFIG;
	customQueries?: Record<string, CustomQueryFunction>;
	errorHandler: (error: unknown, req: Request, res: AlokaiResponse) => void;
	extensions: ApiClientExtension<API>[];
	initConfig: TObject;
	retry?: boolean | RetryConfig;
}

Properties

NameRequiredTypeDescription
apiClientRequiredApiClientFactory<CONFIG, API>
circuitBreakerOptional{ granularity?: CircuitBreakerGranularity; methods?: string[]; preset: CircuitBreakerPreset; }
configurationRequiredCONFIG
customQueriesOptionalRecord<string, CustomQueryFunction>
errorHandlerRequired(error: unknown, req: Request, res: AlokaiResponse) => void
extensionsRequiredApiClientExtension<API>[]
initConfigRequiredTObject
retryOptionalboolean | RetryConfig

Referenced Types

On this page