VisibilityFilter

reference

1 min readUpdated 2026-07-30

Kind: Class

Source: atloria-monorepo/libs/parser-core/src/generators/versioning/visibility-filter.ts

Methods

Method	Signature	Returns
`filter`	`filter(entities: Entity[], config: VisibilityFilterConfig)`	`FilteredEntities`
`generateFilterUI`	`generateFilterUI(config: VisibilityFilterConfig)`	`string`
`generateFrontmatter`	`generateFrontmatter(entity: Entity)`	`Record<string, unknown>`

VisibilityFilter stops the work with an early return when metadata?.['deprecated'] === true || description.includes('@deprecated'), in 2 places.
VisibilityFilter stops the work with an early return when config.customFilter && !config.customFilter(entity).
VisibilityFilter stops the work with an early return when metadata?.['access'] === 'private' || tags.includes('private').
VisibilityFilter stops the work with an early return when metadata?.['internal'] === true || description.includes('@internal').
VisibilityFilter stops the work with an early return when metadata?.['access'] === 'protected' || tags.includes('protected').
VisibilityFilter stops the work with an early return when stability === 'alpha' || tags.includes('alpha').