n8n-nodes-semble v2.1.0


n8n-nodes-semble / services/FieldDiscoveryService / FieldDiscoveryConfig

Interface: FieldDiscoveryConfig

Defined in: services/FieldDiscoveryService.ts:55

Configuration interface for field discovery service

Defines all configuration options needed to initialize a FieldDiscoveryService instance with proper caching, validation, and introspection settings.

Example

const config: FieldDiscoveryConfig = {
  queryService: new SembleQueryService(queryConfig),
  cacheService: new CacheService(cacheConfig),
  introspectionCacheTtl: 3600, // 1 hour
  includeDeprecated: false,
  maxDepth: 5,
  enableSchemaValidation: true
};

const discoveryService = new FieldDiscoveryService(config);

FieldDiscoveryConfig

Since

2.0.0

Extends

  • BaseServiceConfig

Properties

queryService

queryService: SembleQueryService

Defined in: services/FieldDiscoveryService.ts:57

Required query service for executing GraphQL introspection queries


cacheService?

optional cacheService: CacheService

Defined in: services/FieldDiscoveryService.ts:59

Optional cache service for storing introspection results


introspectionCacheTtl?

optional introspectionCacheTtl: number

Defined in: services/FieldDiscoveryService.ts:61

Cache TTL for introspection results in seconds (default: 1 hour)


includeDeprecated?

optional includeDeprecated: boolean

Defined in: services/FieldDiscoveryService.ts:63

Whether to include deprecated fields in discovery results


maxDepth?

optional maxDepth: number

Defined in: services/FieldDiscoveryService.ts:65

Maximum depth for nested type discovery


enableSchemaValidation?

optional enableSchemaValidation: boolean

Defined in: services/FieldDiscoveryService.ts:67

Whether to enable schema validation after introspection


name

name: string

Defined in: types/ConfigTypes.ts:81

Service name for identification

Inherited from

BaseServiceConfig.name


enabled

enabled: boolean

Defined in: types/ConfigTypes.ts:83

Enable/disable the service

Inherited from

BaseServiceConfig.enabled


initTimeout

initTimeout: number

Defined in: types/ConfigTypes.ts:85

Service initialization timeout in ms

Inherited from

BaseServiceConfig.initTimeout


options

options: Record\<string, any>

Defined in: types/ConfigTypes.ts:87

Service-specific configuration

Inherited from

BaseServiceConfig.options