ValidDocParamTypes

Last edit: Apr 01, 2026

ValidDocParamTypes

Severity: error | Type: LiquidHtml

This check ensures that type annotations in {% doc %} tag @param entries are valid platformOS types. Invalid type names prevent tooling (autocomplete, type checking) from working correctly and indicate a mistake in the documentation.

Valid types are derived from the platformOS docset and include primitive types (string, number, boolean) as well as platformOS-specific object types (e.g. User, Record, etc.).

Examples

✗ Incorrect Code Example (Avoid using this):


{% doc %}
  @param {Integer} count - A count value
  @param {txt} label - A label string
{% enddoc %}

Integer and txt are not valid platformOS types.

✓ Correct Code Example (Use this instead):


{% doc %}
  @param {number} count - A count value
  @param {string} label - A label string
{% enddoc %}

Configuration

The default configuration for this check:

ValidDocParamTypes:
  enabled: true
  severity: error

Disabling This Check

Disabling this check is not recommended. Run pos-cli check update-docs to refresh the platformOS docset if you are getting false positives after a platform update.

ValidDocParamTypes