Function getVersionAlias

  • Gets the alias of the given version, e.g. 'stable' or 'dev'.

    Remarks

    Versions lower than 1.0.0 or with a pre-release label (e.g. 1.0.0-alpha.1) will be considered 'dev'. All other versions will be considered 'stable'.

    Returns

    The alias of the given version.

    Parameters

    • Optional version: string

      Defaults to the version from package.json

    • Optional stable: "auto" | `v${string}` = 'auto'

      The version set in the typedoc options for the 'stable' alias.

    • Optional dev: "auto" | `v${string}` = 'auto'

      The version set in the options for the 'dev' alias.

    Returns semanticAlias

Settings

Member Visibility

Theme

Generated using TypeDoc