FireGuard Frontend API¶
FireGuard Frontend Public API and Type Exports.
This module serves as the entry point for TypeDoc API documentation generation. Exports all public-facing types and custom hooks that should be documented.
Public exports include: - Custom React hooks for fire risk monitoring and subscriptions - TypeScript type definitions for API responses and domain entities - Integration utilities for backend API and realt-time services
Interfaces¶
- ApiError
- BaseHATEOASResponse
- FireRiskReading
- GeoJSONFeature
- GeoJSONFeatureCollection
- GeoJSONProperties
- GeoSearchResult
- HATEOASLink
- MapFeature
- MonitoredZone
- RiskLegend
- RiskLevel
- SkippedFeature
- StreamRiskData
- SubscriptionResponse
- ThingSpeakChannel
- ThingSpeakFeed
- ThingSpeakResponse
- UserSubscriptionListResponse
Type Aliases¶
Variables¶
- API_URL
- KEYCLOAK_CLIENT_ID
- KEYCLOAK_REALM
- KEYCLOAK_URL
- MQTT_BROKER_URL
- MQTT_PASSWORD
- MQTT_USERNAME
- projectConfig
- THINGSPEAK_CHANNEL_ID
- THINGSPEAK_READ_API_KEY