@hrefcl/apidoc - v4.0.5
    Preparing search index...
    • Parser for ratelimit tags - defines MQTT rate limiting recommendations

      This parser handles the ratelimit tag that defines recommended rate limits for MQTT publishing or subscribing. It extracts:

      • Rate value (number)
      • Time unit (second, minute, hour, day)
      • Optional description

      Parameters

      • content: string

        Raw content from the ratelimit tag

      Returns { rate: number; unit: string; description: string }

      Parsed rate limit information, or null if parsing fails

      // Input: "10/second Maximum telemetry frequency"
      // Output: { rate: 10, unit: "second", description: "Maximum telemetry frequency" }
      // Input: "5/minute Command rate limit per device"
      // Output: { rate: 5, unit: "minute", description: "Command rate limit per device" }
      // Input: "100/hour"
      // Output: { rate: 100, unit: "hour", description: "" }

      4.1.0