ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
69 lines • 2.09 kB
TypeScript
/**
* @fileoverview Configuration Management for WS-Dottie
*
* This module provides configuration management for WS-Dottie API operations,
* including API key and domain configuration with runtime modification
* capability. It supports environment variable configuration and runtime
* updates for different deployment scenarios.
*/
/**
* Configuration interface for WS-Dottie
*
* Defines the structure for WS-Dottie configuration including API key
* and domain settings.
*/
export interface WsdotConfig {
/** WSDOT API access token for authentication */
apiKey: string;
/** Base domain for API requests */
domain: string;
}
/**
* Gets the current WSDOT API access token
*
* This function returns the currently configured API access token,
* which is used for authenticating requests to WSDOT/WSF APIs.
*
* @returns The current API key string
*/
export declare const getApiKey: () => string;
/**
* Gets the current WSDOT base URL
*
* This function returns the currently configured base URL for
* WSDOT/WSF API requests.
*
* @returns The current base URL string
*/
export declare const getDomain: () => string;
/**
* Sets the WSDOT API access token
*
* This function allows runtime modification of the API access token,
* useful for different environments or when tokens need to be updated.
*
* @param apiKey - The new API key string to set
*/
export declare const setApiKey: (apiKey: string) => void;
/**
* Sets WSDOT base URL
*
* This function allows runtime modification of the base URL,
* useful for different environments or API endpoints.
*
* @param domain - The new domain string to set
*/
export declare const setBaseUrl: (domain: string) => void;
/**
* Configuration manager object
*
* This object provides a convenient interface for accessing and
* modifying WS-Dottie configuration settings.
*/
export declare const configManager: {
getApiKey: () => string;
getDomain: () => string;
setApiKey: (apiKey: string) => void;
setBaseUrl: (domain: string) => void;
};
//# sourceMappingURL=configManager.d.ts.map