n8n-nodes-semble v2.1.0

n8n-nodes-semble / services/FieldDiscoveryService / DiscoveryOptions

Interface: DiscoveryOptions¶

Defined in: services/FieldDiscoveryService.ts:139

Options interface for controlling field discovery behavior

Provides fine-grained control over schema introspection and field discovery operations, including filtering, caching, and deprecation handling.

Example¶

// Basic discovery with caching
const basicOptions: DiscoveryOptions = {
  useCache: true,
  includeDeprecated: false
};

// Filtered discovery for specific types
const filteredOptions: DiscoveryOptions = {
  typeFilter: ['Patient', 'Booking'],
  fieldFilter: ['id', 'firstName', 'lastName'],
  maxDepth: 3
};

// Force refresh discovery
const refreshOptions: DiscoveryOptions = {
  refreshCache: true,
  includeDeprecated: true
};

DiscoveryOptions

Since¶

2.0.0

Properties¶

includeDeprecated?¶

optional includeDeprecated: boolean

Defined in: services/FieldDiscoveryService.ts:141

Whether to include deprecated fields and types in results

typeFilter?¶

optional typeFilter: string[]

Defined in: services/FieldDiscoveryService.ts:143

Array of type names to include (filters out others)

fieldFilter?¶

optional fieldFilter: string[]

Defined in: services/FieldDiscoveryService.ts:145

Array of field names to include (filters out others)

maxDepth?¶

optional maxDepth: number

Defined in: services/FieldDiscoveryService.ts:147

Maximum depth for nested type traversal

useCache?¶

optional useCache: boolean

Defined in: services/FieldDiscoveryService.ts:149

Whether to use cached results if available

refreshCache?¶

optional refreshCache: boolean

Defined in: services/FieldDiscoveryService.ts:151

Whether to force refresh of cached results