Class VocabularyClient

Sub-client for EP controlled-vocabularies endpoints.

Hierarchy (View Summary)

BaseEPClient
- VocabularyClient

Index

Constructors

constructor

new VocabularyClient(
config?: EPClientConfig,
shared?: EPSharedResources,
): VocabularyClient
Parameters
- config: EPClientConfig = {}
- Optionalshared: EPSharedResources
Returns VocabularyClient
Overrides BaseEPClient.constructor
- Defined in clients/ep/vocabularyClient.ts:27

Properties

`Protected` `Readonly`baseURL

baseURL: string

European Parliament API base URL.

`Protected` `Readonly`cache

cache: LRUCache<string, Record<string, unknown>>

LRU cache for API responses.

`Protected` `Readonly`enableRetry

enableRetry: boolean

Enable automatic retry on transient failures.

`Protected` `Readonly`maxResponseBytes

maxResponseBytes: number

Maximum allowed response body size in bytes.

`Protected` `Readonly`maxRetries

maxRetries: number

Maximum number of retry attempts.

`Protected` `Readonly`rateLimiter

rateLimiter: RateLimiter

Token bucket rate limiter.

`Protected` `Readonly`timeoutMs

timeoutMs: number

Request timeout in milliseconds.

Methods

clearCache

clearCache(): void
Clears all entries from the LRU cache.

Returns void
Inherited from BaseEPClient.clearCache
- Defined in clients/ep/baseClient.ts:694

`Protected`get

get<T extends Record<string, unknown>>(
    endpoint: string,
    params?: Record<string, unknown>,
    minimumTimeoutMs?: number,
): Promise<T>
Protected
Executes a cached, rate-limited GET request to the EP API.
Type Parameters
- T extends Record<string, unknown>
  Expected response type (extends Record<string, unknown>)
Parameters
- endpoint: string
  API endpoint path (relative to baseURL)
- Optionalparams: Record<string, unknown>
  Optional query parameters
- OptionalminimumTimeoutMs: number
  Optional per-request minimum timeout in milliseconds. When provided, the effective timeout is Math.max(minimumTimeoutMs, this.timeoutMs), so the global timeout (set via --timeout or EP_REQUEST_TIMEOUT_MS) can still extend it beyond the per-endpoint minimum. Use for known slow EP API endpoints such as procedures/feed and events/feed.
Returns Promise<T>
Promise resolving to the typed API response

Throws
On HTTP errors, network failures, or parse failures
Inherited from BaseEPClient.get
- Defined in clients/ep/baseClient.ts:626

getCacheStats

getCacheStats(): {
    hitRate: number;
    hits: number;
    maxSize: number;
    misses: number;
    size: number;
}
Returns cache statistics for monitoring and debugging.

Returns { hitRate: number; hits: number; maxSize: number; misses: number; size: number }
{ size, maxSize, hitRate, hits, misses }
Inherited from BaseEPClient.getCacheStats
- Defined in clients/ep/baseClient.ts:703

getControlledVocabularies

getControlledVocabularies(
params?: { limit?: number; offset?: number },
): Promise<PaginatedResponse<Record<string, unknown>>>
Returns EP controlled vocabularies. EP API Endpoint: GET /controlled-vocabularies
Parameters
- params: { limit?: number; offset?: number } = {}
  limit, offset
Returns Promise<PaginatedResponse<Record<string, unknown>>>
Raw API response with vocabulary items
- Defined in clients/ep/vocabularyClient.ts:40

getControlledVocabulariesFeed

getControlledVocabulariesFeed(
params?: { startDate?: string; timeframe?: string },
): Promise<JSONLDResponse<Record<string, unknown>>>
Retrieves recently updated controlled vocabularies via the feed endpoint. EP API Endpoint: GET /controlled-vocabularies/feed
Parameters
- params: { startDate?: string; timeframe?: string } = {}
Returns Promise<JSONLDResponse<Record<string, unknown>>>
- Defined in clients/ep/vocabularyClient.ts:62

getControlledVocabularyById

getControlledVocabularyById(vocId: string): Promise<Record<string, unknown>>
Returns a single EP Controlled Vocabulary by ID. EP API Endpoint: GET /controlled-vocabularies/{voc-id}
Parameters
- vocId: string
  Vocabulary identifier
Returns Promise<Record<string, unknown>>
Single vocabulary entry
- Defined in clients/ep/vocabularyClient.ts:80

Class VocabularyClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VocabularyClient

Properties

`Protected` `Readonly`baseURL

`Protected` `Readonly`cache

`Protected` `Readonly`enableRetry

`Protected` `Readonly`maxResponseBytes

`Protected` `Readonly`maxRetries

`Protected` `Readonly`rateLimiter

`Protected` `Readonly`timeoutMs

Methods

clearCache

Returns void

`Protected`get

Type Parameters

Parameters

Returns Promise<T>

Throws

getCacheStats

Returns { hitRate: number; hits: number; maxSize: number; misses: number; size: number }

getControlledVocabularies

Parameters

Returns Promise<PaginatedResponse<Record<string, unknown>>>

getControlledVocabulariesFeed

Parameters

Returns Promise<JSONLDResponse<Record<string, unknown>>>

getControlledVocabularyById

Parameters

Returns Promise<Record<string, unknown>>

Settings

On This Page

Class VocabularyClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VocabularyClient

Properties

Protected ReadonlybaseURL

Protected Readonlycache

Protected ReadonlyenableRetry

Protected ReadonlymaxResponseBytes

Protected ReadonlymaxRetries

Protected ReadonlyrateLimiter

Protected ReadonlytimeoutMs

Methods

clearCache

Returns void

Protectedget

Type Parameters

Parameters

Returns Promise<T>

Throws

getCacheStats

Returns { hitRate: number; hits: number; maxSize: number; misses: number; size: number }

getControlledVocabularies

Parameters

Returns Promise<PaginatedResponse<Record<string, unknown>>>

getControlledVocabulariesFeed

Parameters

Returns Promise<JSONLDResponse<Record<string, unknown>>>

getControlledVocabularyById

Parameters

Returns Promise<Record<string, unknown>>

Settings

On This Page

`Protected` `Readonly`baseURL

`Protected` `Readonly`cache

`Protected` `Readonly`enableRetry

`Protected` `Readonly`maxResponseBytes

`Protected` `Readonly`maxRetries

`Protected` `Readonly`rateLimiter

`Protected` `Readonly`timeoutMs

`Protected`get