fleeta-api-lib
Version:
A comprehensive library for fleet management applications - API, Auth, Device management
60 lines • 1.85 kB
TypeScript
/**
* API Endpoint Utilities
* Provides centralized access to API endpoints and tokens
*/
/**
* API Endpoint Configuration Interface
*/
export interface ApiEndpointConfig {
apiGateway: string;
iotApiGateway: string;
gpsWebSocketUrl: string;
eventWebSocketUrl: string;
}
/**
* Get API endpoint configuration from store
* @returns ApiEndpointConfig or null if not initialized
*/
export declare function getApiEndpointConfig(): ApiEndpointConfig | null;
/**
* Check if API endpoints are configured
* @returns True if endpoints are configured
*/
export declare function isApiEndpointConfigured(): boolean;
/**
* Get specific API endpoint
* @param endpoint - Endpoint type to retrieve
* @returns Endpoint URL or null if not configured
*/
export declare function getApiEndpoint(endpoint: keyof ApiEndpointConfig): string | null;
/**
* Get API Gateway URL
* @returns API Gateway URL or throws error if not configured
*/
export declare function getApiGateway(): string;
/**
* Get IoT API Gateway URL
* @returns IoT API Gateway URL or throws error if not configured
*/
export declare function getIotApiGateway(): string;
/**
* Get GPS WebSocket URL
* @returns GPS WebSocket URL or throws error if not configured
*/
export declare function getGpsWebSocketUrl(): string;
/**
* Get Event WebSocket URL
* @returns Event WebSocket URL or throws error if not configured
*/
export declare function getEventWebSocketUrl(): string;
/**
* Get API endpoint configuration error message
* @returns Standard endpoint configuration error message
*/
export declare function getEndpointErrorMessage(): string;
/**
* Validate all required endpoints are configured
* @returns True if all required endpoints are configured
*/
export declare function validateApiEndpoints(): boolean;
//# sourceMappingURL=endpointUtils.d.ts.map