UNPKG

@swimmable/sdk

Version:

Official JavaScript/TypeScript SDK for the Swimmable API - Real-time swimming conditions and water quality data

27 lines 1.32 kB
/** * Swimmable JavaScript/TypeScript SDK * Official SDK for the Swimmable API - Real-time swimming conditions and water quality data * * @example * ```typescript * import { SwimmableClient } from '@swimmable/sdk'; * * const client = new SwimmableClient({ * apiKey: 'your-api-key-here' * }); * * // Get basic conditions * const conditions = await client.getConditions({ lat: 34.0522, lon: -118.2437 }); * console.log(`Water temperature: ${conditions.waterTemperature}°C`); * * // Get enhanced conditions with safety scores * const enhanced = await client.getEnhancedConditions({ lat: 34.0522, lon: -118.2437 }); * console.log(`Swimmability score: ${enhanced.swimmabilityScore}/10`); * ``` */ export { SwimmableClient, createClient } from './client'; export type { SwimmableConfig, Coordinates, BasicConditions, EnhancedConditions, SpotsResponse, SpotInfo, HealthStatus, UsageStats, ApiKeyInfo, CreateApiKeyRequest, CreateApiKeyResponse, RequestOptions, } from './types'; export { LocationUtils, ConditionsUtils, ApiKeyUtils, RateLimiter, } from './utils'; export { SwimmableError, SwimmableAPIError, SwimmableTimeoutError, SwimmableValidationError, SwimmableAuthenticationError, SwimmableRateLimitError, } from './exceptions'; export declare const VERSION = "1.0.0"; //# sourceMappingURL=index.d.ts.map