Skip to content

VersionSelectorGenerator

reference
1 min readUpdated

Kind: Class

Source: atloria-monorepo/libs/parser-core/src/generators/versioning/version-selector.generator.ts

Methods

MethodSignatureReturns
generategenerate(config: VersionConfig, options: VersionSelectorOptions)string
generateBannergenerateBanner(config: VersionConfig, options: VersionSelectorOptions)string
generateDropdowngenerateDropdown(config: VersionConfig, options: Required<Pick<VersionSelectorOptions, 'showLabels'>> & VersionSelectorOptions)string
generateFrontmattergenerateFrontmatter(config: VersionConfig)Record<string, unknown>
generateEntityVersionSwitchergenerateEntityVersionSwitcher(config: VersionConfig, entityPath: string, _options: VersionSelectorOptions)string

Where it refuses work

  • VersionSelectorGenerator stops the work with an early return when !current.
  • VersionSelectorGenerator stops the work with an early return when isLatest && !current.isDeprecated && !VersionUtils.isEOL(current).
  • VersionSelectorGenerator stops the work with an early return when !status.

Was this page helpful?

Download as PDF